CATGSMUseItf CATGSMUICmdInfo

Usage: you must use this class as is. You should never derive it.

public class CATGSMUICmdInfo

Class to define informations for running contextual GSD command.
Role: Allows to choose some paramerters when running GSD contextual commands.

See also:

Constructor and Destructor Index

o CATGSMUICmdInfo()

Constructor.

o ~CATGSMUICmdInfo()

Destructor.

Method Index

o GetClassName()

o GetContextualFeaturesAggregMode()

Gets the aggregate mode for generated feature in context.

o GetDatumMode()

Gets he datum mode for creation in context.

o GetInsertAfterCurrentFeatMode()

Gets the insertion position for generated feature.

o GetSelectorContextualItem()

Gets the contextual additionnal information.

o GetStartUpName()

Gets the startUp name for the Command to be launch.

o GetWorkingPart()

Gets the working part.

o SetClassName(char*)

Sets the class name corresponding to GSD command.

o SetContextualFeaturesAggregMode(int)

Sets the aggregate mode for generated featuree in context.

o SetDatumMode(int)

Sets he datum mode for creation in context.

o SetInsertAfterCurrentFeatMode(int)

Sets the insertion position for generated feature.

o SetSelectorContextualItem(CATUnicodeString)

Sets the contextual additionnal information.

o SetStartUpName(CATUnicodeString)

Sets the startUp name for the Command to be launch.

o SetWorkingPart(CATPathElement*)

Sets the working part.

Constructor and Destructor

Constructor.

Destructor.

Methods

Gets the aggregate mode for generated feature in context.

Returns:

mode = 0 Normal / feature is insert in OpenBody at creation (default and standard mode CAA)
mode = 1 Aggregated / feature is inserted in open body and tag to be aggreagated == Internal Use Only ==

Gets he datum mode for creation in context.

Returns:

Mode = 0 / Creation of feature Mode = 1 / creation in datuim mode
if DatumMode=1, the command is started in datum mode (no history) otherwise it is started in procedural mode
Note: Default is procedural mode

Gets the insertion position for generated feature.

Returns:

mode = 0 If the tool is Hybrid Body or OGS the new feature would be inserted before current feature
mode = 1 If the tool is Hybrid Body or OGS the new feature would be inserted after current feature

Gets the contextual additionnal information.

Returns:

Item to precise when running the start up

Gets the startUp name for the Command to be launch.

Gets the working part.

Returns:

The complete path to the CATPart in which one the new geometrical element will be created. If set, the UI-Active element does not have to be a CATPart.
Note: Default is NULL

Sets the class name corresponding to GSD command.
note : Used in DMU context / activation of a GSD command whithin a given part

Parameters:

ClassName

Class Name string of the element to create,

Sets the aggregate mode for generated featuree in context.

Parameters:

iMode

mode = 0 Normal / feature is insert in OpenBody at creation (default and standard mode CAA)
mode = 1 Aggregated / feature is inserted in open body and tag to be aggreagated == Internal Use Only == The feature has to be re-aggregated in the Activate method of the caller command (Chage father)
Note: It is reauire to perform the re-aggregation coirrectly other wise model if garbaged

See also:

Sets he datum mode for creation in context.

Parameters:

iDatumMode

Mode = 0 / Creation of feature Mode = 1 / creation in datuim mode
if DatumMode=1, the command is started in datum mode (no history) otherwise it is started in procedural mode
Note: Default is procedural mode

Sets the insertion position for generated feature.

Parameters:

iInsertAfterCurrentFeatMode

iInsertAfterCurrentFeatMode = 0 If the tool is Hybrid Body or OGS the new feature would be inserted before current feature
iInsertAfterCurrentFeatMode = 1 If the tool is Hybrid Body or OGS the new feature would be inserted after current feature
Note: By default the value of "iInsertAfterCurrentFeatMode" is 0

Sets the contextual additionnal information.

Parameters:

ContextualItem

Item to precise when running the start up
used to element to create on the fly

     Command           StartUp Name           Item                   Icon Name  
     -----------------------------------------------------------------------------
     X Axis             "GSMRefElementOnFly"   ItemX_AxisCreate       "I_LineXAxis" 
     Y Axis             "GSMRefElementOnFly"   ItemY_AxisCreate       "I_LineYAxis" 
     Z Axis             "GSMRefElementOnFly"   ItemZ_AxisCreate       "I_LineZAxis" 
     X Axis (Current)   "GSMRefElementOnFly"   ItemLocalX_AxisCreate  "I_LineXAxis" 
     Y Axis (Current)   "GSMRefElementOnFly"   ItemLocalY_AxisCreate  "I_LineYAxis" 
     Z Axis (Current)   "GSMRefElementOnFly"   ItemLocalZ_AxisCreate  "I_LineZAxis" 
     XY Plane           "GSMRefElementOnFly"   ItemXYPlaneCreate      "I_LineXAxis" 
     YZ Plane           "GSMRefElementOnFly"   ItemYZPlaneCreate      "I_LineYAxis" 
     ZX Plane           "GSMRefElementOnFly"   ItemZXPlaneCreate      "I_LineZAxis" 
     XY Plane (Current) "GSMRefElementOnFly"   ItemLocalXYPlaneCreate "I_LineXAxis" 
     YZ Plane (Current) "GSMRefElementOnFly"   ItemLocalYZPlaneCreate "I_LineYAxis" 
     ZX Plane (Current) "GSMRefElementOnFly"   ItemLocalZXPlaneCreate "I_LineZAxis" 
  

Sets the startUp name for the Command to be launch.

Parameters:

StartUpName

Interface name of the element to create,
List of available commands :

     Command                         StartUp Name                Icon Name          
   ------------------------------------------------------------------------------
   Point interactive command       "GSMPoint"                  "I_Point"
   MidPoint                        "GSMMidPoint"               "I_Midpoint"
   EndPoint                        "GSMEndPoint"               "I_Endpoint"
   Line interactive command        "GSMLine"                   "I_Line"
   Plane interactive command       "GSMPlane"                  "I_Plane"
   Intersect interactive command   "GSMIntersect"              "I_Intersection"
   Project interactive command     "GSMProject"                "I_Project"
   Join interactive command        "GSMAssemble"               "I_AssembleBipar"
   Boundary interactive command    "GSMBoundary"               "I_Boundary"
   Extract interactive command     "GSMExtract"                "I_Extract"
   Extrapol interactive command    "GSMExtrapol"               "I_Extrapol"
   Law  interactive command        "GSMLaw"                    "I_Law"
   Extremum interactive command    "GSMExtremum"               "I_Extremum"
   CurveSmooth interactive command "GSMCurveSmooth"            "I_CurveSmooth"
   Spine interactive command       "GSMSpine"                  "I_Spine"
   Loft interactive command        "GSMLoft"                   "I_Loft"
   Blend interactive command       "GSMBlend"                  "I_Blend"
   Multiple Pt interactive command "GSMMultiplePoint"          "I_MultiplePoint"
   Trim  interactive command       "GSMTrim"                   "I_Trim"	
   Spline interactive command      "GSMCurve"                  "I_Curve"
   Polyline interactive command    "GSMLineCorner"             "I_LineCorner"
   Near  interactive command       "GSMNear"                   "I_Near"
   3D Curve offset interactive cmd "GSM3DurveOffset"           "I_3DCurveOffset"
   Sketch command				   "PRTSketch"				   "I_Sketcher"
   Axis System interactive command "AxisSystem"				   "I_3DAxisSystemGSD"
   3D Curve interactive command	   "St3DCurveFeature"		   "I_St3DCurve"
  

Sets the working part.

Parameters:

iWorkingPart

The complete path to the CATPart in which one the new geometrical element will be created. If set, the UI-Active element does not have to be a CATPart.
Note: Default is NULL

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.