Bentley.GS library

Hi,

Does certain reference manual exists on Bentley.GS library? Would be nice to get more deep overview on how these functions intended to be used. I understand the self-explanatory idea of GS function but still wonder if more than just description exists…

What “Option” (for ex: AxisOption) word in names means?

Would be very thankful if someone provides conceptual advice how to use these functions

Thanks in advance.

Parents
  • Hi Peter,

    Do you mean the Bentley.GC types and members as shown in the Expression Builder?

    Most often items with suffix "Option" enumerate options for eponymous properties which are available for those input properties as drop-down selections. "AxisOption", for example, is the type expected for an input property named "Axis", e.g. the Axis input property for Plane.ByOriginRotationAboutCoordinateSystem( ).  "AxisOption" can have values "X", "Y", and "Z".  When scripting, the input for "Axis" as shown in the fly-over technique signature then is AxisOption.X (or .Y, .Z).  In this case, this is relatively straightforward, because in the context, auto-completion will help auto-complete AxisOption and will show what the available values/members are after typing the dot. 

    The specific items are not documented (e.g. in which locations the type "AxisOption" may get used); however, the GC help section GCScript Programming provides an overview.

    HTH,

          Volker

       

Reply
  • Hi Peter,

    Do you mean the Bentley.GC types and members as shown in the Expression Builder?

    Most often items with suffix "Option" enumerate options for eponymous properties which are available for those input properties as drop-down selections. "AxisOption", for example, is the type expected for an input property named "Axis", e.g. the Axis input property for Plane.ByOriginRotationAboutCoordinateSystem( ).  "AxisOption" can have values "X", "Y", and "Z".  When scripting, the input for "Axis" as shown in the fly-over technique signature then is AxisOption.X (or .Y, .Z).  In this case, this is relatively straightforward, because in the context, auto-completion will help auto-complete AxisOption and will show what the available values/members are after typing the dot. 

    The specific items are not documented (e.g. in which locations the type "AxisOption" may get used); however, the GC help section GCScript Programming provides an overview.

    HTH,

          Volker

       

Children
No Data