CATGSMUseItf Interface CATIGSMUseCartesianGrid
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseCartesianGrid
Cartesian grid feature : allows to manipulate the data of cartesian grid.
Role: Allows to associate a cartesian grid to a working support
Note: Cartesian Grid is associated necessary to a planar working support
- See also:
-
- See also:
-
Method Index
- o
Get3DFurtiveGridLabel(CATGSMCartesianGridLabel&,CATUnicodeString&,CATUnicodeString&)
- Gets Label for the 3D Furtive Grid.
- o
GetAxis(CATMathPoint&,CATMathDirection&,CATMathDirection&)
- Gets the grid origin and axis.
- o
GetFirstDirPrimarySpacing(CATICkeParm_var&)
- Gets the first direction primary spacing.
- o
GetFirstDirSecondaryStep(CATICkeParm_var&)
- Gets the first direction secondary subdivisions number.
- o
GetFirstDirVisibleAreaOrientation()
- Gets the first direction visible area orientation.
- o
GetFirstDirVisibleAreaRange(CATICkeParm_var&)
- Gets the first direction visible area range.
- o
GetFirstDirection(CATIGSMUseDirection_var&)
- Gets the first direction on the plane (H).
- o
GetOriginForRanges(CATIMmiMechanicalFeature_var&)
- Gets Origin for ranges.
- o
GetPlaneShading()
- Gets grid plane shading.
- o
GetSameSteps()
- Gets the status for same values for first and second directions spacing and step.
- o
GetSecondDirPrimarySpacing(CATICkeParm_var&)
- Gets the second direction primary spacing.
- o
GetSecondDirSecondaryStep(CATICkeParm_var&)
- Gets the second direction secondary subdivisions number.
- o
GetSecondDirVisibleAreaOrientation()
- Gets the second direction visible area orientation.
- o
GetSecondDirVisibleAreaRange(CATICkeParm_var&)
- Gets the second direction visible area range.
- o
GetSecondDirection(CATMathDirection&)
- Gets the second direction on the plane (V).
- o
GetType()
- Gets type.
- o
ResetOrigin()
- Resets the grid origin.
- o
Set3DFurtiveGridLabel(CATGSMCartesianGridLabel,CATUnicodeString&,CATUnicodeString&)
- Sets Label for the 3D Furtive Grid.
- o
SetFirstDirPrimarySpacing(CATICkeParm_var&)
- Sets the first direction primary spacing.
- o
SetFirstDirSecondaryStep(CATICkeParm_var&)
- Sets the first direction secondary subdivisions number.
- o
SetFirstDirVisibleAreaOrientation(CATGSMOrientation)
- Sets the first direction visible area orientation.
- o
SetFirstDirVisibleAreaRange(CATICkeParm_var&)
- Sets the first direction visible area range.
- o
SetFirstDirection(CATIGSMUseDirection_var)
- Sets the first direction on the plane (H).
- o
SetOrigin(CATMathPoint&)
- Sets the grid origin.
- o
SetOriginForRanges(CATIMmiMechanicalFeature_var&)
- Sets Origin for ranges.
- o
SetPlaneShading(int)
- Sets grid plane shading.
- o
SetSameSteps(int)
- Sets the same values for first and second directions spacing and step.
- o
SetSecondDirPrimarySpacing(CATICkeParm_var&)
- Sets the second direction primary spacing.
- o
SetSecondDirSecondaryStep(CATICkeParm_var&)
- Sets the second direction secondary subdivisions number.
- o
SetSecondDirVisibleAreaOrientation(CATGSMOrientation)
- Sets the second direction visible area orientation.
- o
SetSecondDirVisibleAreaRange(CATICkeParm_var&)
- Sets the second direction visible area range.
- o
SetSecondDirection(CATMathDirection&)
- Sets the second direction on the plane (V).
- o
SetType(enum CATGSMGridType)
- Sets type.
Enumerated Type Index
- o
CATGSMGridType
- Types for grid ( Finite, Infinite).
Methods
o Get3DFurtiveGridLabel
| public virtual Get3DFurtiveGridLabel( | | Position, |
| | FirstDirText, |
| | SecondDirText) |
-
Gets Label for the 3D Furtive Grid.
Note: If no Label user defined, gets default label names
- Parameters:
-
- Position
- Position of the label
- First
- direction Label (H) Name of the H Label
- Second
- direction Label (V) Neam of the second direction Label
o GetAxis
| public virtual GetAxis( | | oOrigin, |
| | oFirstDir, |
| | oSecondDir) |
-
Gets the grid origin and axis.
- Parameters:
-
- oOrigin
- the grid origin
- oFirstDir
- the grid first direction (H)
- oSecondDir
- the grid second direction (V)
o GetFirstDirPrimarySpacing
| public virtual GetFirstDirPrimarySpacing( | | HSpacing) |
-
Gets the first direction primary spacing.
- Parameters:
-
- HSpacing
- The literal parameter of length type
o GetFirstDirSecondaryStep
| public virtual GetFirstDirSecondaryStep( | | HStep) |
-
Gets the first direction secondary subdivisions number.
- Parameters:
-
- HStep
- The literal parameter of integer type
o GetFirstDirVisibleAreaOrientation
| public virtual GetFirstDirVisibleAreaOrientation( | ) |
-
Gets the first direction visible area orientation.
Returned value : enum {CATGSMSameOrientation, CATGSMInvertOrientation}
o GetFirstDirVisibleAreaRange
| public virtual GetFirstDirVisibleAreaRange( | | Range) |
-
Gets the first direction visible area range.
- Parameters:
-
- Range
- The literal parameter of length type
o GetFirstDirection
| public virtual GetFirstDirection( | | oDir) |
-
Gets the first direction on the plane (H).
- Parameters:
-
- oDir
- first direction
- See also:
-
o GetOriginForRanges
| public virtual GetOriginForRanges( | | oOrigin) |
-
Gets Origin for ranges.
- Parameters:
-
- oOrigin
- Origin
o GetPlaneShading
| public virtual GetPlaneShading( | ) |
-
Gets grid plane shading.
Returned value : = 0 Plane is not in shading mode (just grid visualisation)
: = 1 Plane is shaded
o GetSameSteps
| public virtual GetSameSteps( | ) |
-
Gets the status for same values for first and second directions spacing and step.
Returned value : = 0 Not same spacing and step
: = 1 similar spacing and step
o GetSecondDirPrimarySpacing
| public virtual GetSecondDirPrimarySpacing( | | VSpacing) |
-
Gets the second direction primary spacing.
- Parameters:
-
- VSpacing
- The literal parameter of length type
o GetSecondDirSecondaryStep
| public virtual GetSecondDirSecondaryStep( | | VStep) |
-
Gets the second direction secondary subdivisions number.
- Parameters:
-
- VStep
- The literal parameter of integer type
o GetSecondDirVisibleAreaOrientation
| public virtual GetSecondDirVisibleAreaOrientation( | ) |
-
Gets the second direction visible area orientation.
Returned value : enum {CATGSMSameOrientation, CATGSMInvertOrientation}
o GetSecondDirVisibleAreaRange
| public virtual GetSecondDirVisibleAreaRange( | | Range) |
-
Gets the second direction visible area range.
- Parameters:
-
- Range
- The literal parameter of length type
o GetSecondDirection
| public virtual GetSecondDirection( | | oDir) |
-
Gets the second direction on the plane (V).
This direction has to be kept perpendicular to the first direction
- Parameters:
-
- oDir
- second direction
- See also:
-
o GetType
-
Gets type.
Returned value : enum {CATGSMGridFinite, CATGSMGridInfinite}
o ResetOrigin
| public virtual ResetOrigin( | ) |
-
Resets the grid origin.
Origin becomes the defaut: i.e origin of the support
o Set3DFurtiveGridLabel
| public virtual Set3DFurtiveGridLabel( | | Position, |
| const | FirstDirText, |
| const | SecondDirText) |
-
Sets Label for the 3D Furtive Grid.
Allow to redefine the default Label of the Cartesian grid and specify there positions
- Parameters:
-
- Position
- Position of the label
- First
- direction Label (H) Name of the H Label
- Second
- direction Label (V) Neam of the second direction Label
o SetFirstDirPrimarySpacing
| public virtual SetFirstDirPrimarySpacing( | const | HSpacing) |
-
Sets the first direction primary spacing.
Warning : the first time, methods to Sets spacing and steps have to be called in this order :
1. SetFirstDirPrimarySpacing
2. SetFirstDirSecondaryStep
3. SetSecondDirPrimarySpacing
4. SetSecondDirSecondaryStep
- Parameters:
-
- HSpacing
- The literal parameter of length type
o SetFirstDirSecondaryStep
| public virtual SetFirstDirSecondaryStep( | const | HStep) |
-
Sets the first direction secondary subdivisions number.
Warning : the first time, methods to Sets spacing and steps have to be called in this order :
1. SetFirstDirPrimarySpacing
2. SetFirstDirSecondaryStep
3. SetSecondDirPrimarySpacing
4. SetSecondDirSecondaryStep
- Parameters:
-
- HStep
- The literal parameter of integer type
o SetFirstDirVisibleAreaOrientation
| public virtual SetFirstDirVisibleAreaOrientation( | const | iOrientation) |
-
Sets the first direction visible area orientation.
- Parameters:
-
- iOrientation
- first orientation used to choose visible area side
o SetFirstDirVisibleAreaRange
| public virtual SetFirstDirVisibleAreaRange( | const | Range) |
-
Sets the first direction visible area range.
- Parameters:
-
- Range
- The literal parameter of length type
o SetFirstDirection
| public virtual SetFirstDirection( | const | iDir) |
-
Sets the first direction on the plane (H).
- Parameters:
-
- iDir
- first direction
- See also:
-
o SetOrigin
| public virtual SetOrigin( | const | iOrigin) |
-
Sets the grid origin.
- Parameters:
-
- iOrigin
- the grid origin
o SetOriginForRanges
| public virtual SetOriginForRanges( | const | iOrigin) |
-
Sets Origin for ranges.
- Parameters:
-
- iOrigin
- Origin
o SetPlaneShading
| public virtual SetPlaneShading( | const | iShading) |
-
Sets grid plane shading.
- Parameters:
-
- iShading
-
: = 0 Plane is not in shading mode (just grid visualisation)
: = 1 Plane is shaded
o SetSameSteps
| public virtual SetSameSteps( | const | isSame) |
-
Sets the same values for first and second directions spacing and step.
References: first direction values are taken as references
- Parameters:
-
- isSame
-
: = 1 similar spacing and step
o SetSecondDirPrimarySpacing
| public virtual SetSecondDirPrimarySpacing( | const | VSpacing) |
-
Sets the second direction primary spacing.
Warning : the first time, methods to Sets spacing and steps have to be called in this order :
1. SetFirstDirPrimarySpacing
2. SetFirstDirSecondaryStep
3. SetSecondDirPrimarySpacing
4. SetSecondDirSecondaryStep
- Parameters:
-
- VSpacing
- The literal parameter of length type
o SetSecondDirSecondaryStep
| public virtual SetSecondDirSecondaryStep( | const | VStep) |
-
Sets the second direction secondary subdivisions number.
Warning : the first time, methods to Sets spacing and steps have to be called in this order :
1. SetFirstDirPrimarySpacing
2. SetFirstDirSecondaryStep
3. SetSecondDirPrimarySpacing
4. SetSecondDirSecondaryStep
- Parameters:
-
- VStep
- The literal parameter of integer type
o SetSecondDirVisibleAreaOrientation
| public virtual SetSecondDirVisibleAreaOrientation( | const | iOrientation) |
-
Sets the second direction visible area orientation.
- Parameters:
-
- iOrientation
- second orientation used to choose visible area side
o SetSecondDirVisibleAreaRange
| public virtual SetSecondDirVisibleAreaRange( | const | Range) |
-
Sets the second direction visible area range.
- Parameters:
-
- Range
- The literal parameter of length type
o SetSecondDirection
| public virtual SetSecondDirection( | const | iDir) |
-
Sets the second direction on the plane (V).
This direction has to be kept perpendicular to the first direction
- Parameters:
-
- iDir
- second direction
- See also:
-
o SetType
| public virtual SetType( | const | iType) |
-
Sets type.
- Parameters:
-
- iType
- type enum {CATGSMGridFinite, CATGSMGridInfinite}
Enumerated Types
o CATGSMGridType
-
enum CATGSMGridType {
CATGSMGridFinite,
CATGSMGridInfinite
}
Types for grid ( Finite, Infinite).
- Parameters:
-
- CATGSMGridFinite
- Visible area ranges, Origin, Orientation and Furtivity are defined
- CATGSMGridInfinite
- Visible area is the three infinite planes.
This object is included in the file: CATIGSMUseCartesianGrid.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.