All Frameworks Class Hierarchy This Framework Indexes
CATTPSInterfaces Interface CATITPSEditorUIFTAInfraSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITPSEditorUIFTAInfraSettingAtt
Interface to the 3D Annotations Infrastructure setting controller.
Role: The 3D Annotations Infrastructure setting controller object deals with the setting
parameters displayed in:
- The Tolerancing property page
- The Display property page
- The Constructed Geometry property page
- The Manipulators property page
- The Dimension property page
- The Annotation property page
- The Tolerances property page
- The View/Annotation Plane property page
To access this property page:
- Click the Options command in the Tools menu
- Click + left of Mechanical Design to unfold the workbench list
- Click Functionnal Toleracing & Annotation
Method Index
- o
GetAllowDistortionsInfo(CATSettingInfo*)
- Retrieves the state of the AllowDistortions parameter.
- o
GetAllowDistortions(unsigned char*)
- Retrieves the Allow Distortions setting parameter value.
- o
GetGridDisplayInfo(CATSettingInfo*)
- Retrieves the state of the GridDisplay parameter.
- o
GetGridDisplay(unsigned char*)
- Retrieves the Grid Display setting parameter value.
- o
GetGridPrimarySpacingInfo(CATSettingInfo*)
- Retrieves the state of the GridPrimarySpacing parameter.
- o
GetGridPrimarySpacing(double*)
- Retrieves the Grid Primary Spacing setting parameter value.
- o
GetGridSecondaryStepInfo(CATSettingInfo*)
- Retrieves the state of the GridSecondaryStep parameter.
- o
GetGridSecondaryStep(int*)
- Sets the Grid Secondary Spacing setting parameter value.
- o
GetGridSnapPointInfo(CATSettingInfo*)
- Retrieves the state of the GridSnapPoint parameter.
- o
GetGridSnapPoint(unsigned char*)
- Retrieves the Grid Snap Point setting parameter value.
- o
GetGridVPrimarySpacingInfo(CATSettingInfo*)
- Retrieves the state of the GridVPrimarySpacing parameter.
- o
GetGridVPrimarySpacing(double*)
- Retrieves the Grid V Primary Spacing setting parameter value.
- o
GetGridVSecondaryStepInfo(CATSettingInfo*)
- Retrieves the state of the GridVSecondaryStep parameter.
- o
GetGridVSecondaryStep(int*)
- Retrieves the Grid V Secondary Spacing setting parameter value.
- o
GetLeaderAssociativityInfo(CATSettingInfo*)
- Retrieves the state of the Leader Associativity parameter.
- o
GetLeaderAssociativity(unsigned char*)
- Retrieves the Leader Associativity setting parameter value.
- o
GetManRefSizInfo(CATSettingInfo*)
- Retrieves the state of the Manipulator reference size parameter.
- o
GetManRefSiz(double*)
- Retrieves the Manipulator Reference Size setting parameter value.
- o
GetManZooCapInfo(CATSettingInfo*)
- Retrieves the state of the Manipulator zoom capability parameter.
- o
GetManZooCap(unsigned char*)
- Retrieves the Manipulator Zoom Capability Size setting parameter value.
- o
GetMoveAfterCreationInfo(CATSettingInfo*)
- Retrieves the state of the Move After Creation parameter.
- o
GetMoveAfterCreation(unsigned char*)
- Retrieves the Move After Creation setting parameter value.
- o
GetSaveInCGRInfo(CATSettingInfo*)
- Retrieves the state of the Save In CGR parameter.
- o
GetSaveInCGR(unsigned char*)
- Retrieves the Save in CGR setting parameter value.
- o
GetStandardInfo(CATSettingInfo*)
- Retrieves the state of the Standard parameter.
- o
GetStandard(CATUnicodeString&)
- Retrieves the Standard setting parameter value.
- o
GetUnderFeatureInfo(CATSettingInfo*)
- Retrieves the state of the UnderFeature Tree Visu parameter.
- o
GetUnderFeature(unsigned char*)
- Retrieves the Under Feature setting parameter value.
- o
GetUnderSetInfo(CATSettingInfo*)
- Retrieves the state of the UnderSet Tree Visu parameter.
- o
GetUnderSet(unsigned char*)
- Retrieves the Under Set setting parameter value.
- o
GetUnderViewInfo(CATSettingInfo*)
- Retrieves the state of the UnderView Tree Visu parameter.
- o
GetUnderView(unsigned char*)
- Retrieves the Under View setting parameter value.
- o
GetViewAssociativityInfo(CATSettingInfo*)
- Retrieves the state of the View associativity parameter.
- o
GetViewAssociativity(unsigned char*)
- Retrieves the View Associativity setting parameter value.
- o
GetViewProfileInfo(CATSettingInfo*)
- Retrieves the state of the View Profile parameter.
- o
GetViewProfile(unsigned char*)
- Retrieves the View Profile setting parameter value.
- o
GetViewReferentialInfo(CATSettingInfo*)
- Retrieves the state of the View Referential parameter.
- o
GetViewReferentialZoomableInfo(CATSettingInfo*)
- Retrieves the state of the View Referential Zoomable parameter.
- o
GetViewReferentialZoomable(unsigned char*)
- Retrieves the View Referential Zoomable setting parameter value.
- o
GetViewReferential(unsigned char*)
- Retrieves the View Referential setting parameter value.
- o
SetAllowDistortionsLock(unsigned char)
- Locks or unlocks the AllowDistortions parameter.
- o
SetAllowDistortions(unsigned char)
- Sets the Allow Distortions setting parameter value.
- o
SetGridDisplayLock(unsigned char)
- Locks or unlocks the GridDisplay parameter.
- o
SetGridDisplay(unsigned char)
- Sets the Grid Display setting parameter value.
- o
SetGridPrimarySpacingLock(unsigned char)
- Locks or unlocks the GridPrimarySpacing parameter.
- o
SetGridPrimarySpacing(double)
- Sets the Grid Primary Spacing setting parameter value.
- o
SetGridSecondaryStepLock(unsigned char)
- Locks or unlocks the GridSecondaryStep parameter.
- o
SetGridSecondaryStep(int)
- Sets the Grid Secondary Spacing setting parameter value.
- o
SetGridSnapPointLock(unsigned char)
- Locks or unlocks the GridSnapPoint parameter.
- o
SetGridSnapPoint(unsigned char)
- Sets the Grid Snap Point setting parameter value.
- o
SetGridVPrimarySpacingLock(unsigned char)
- Locks or unlocks the GridVPrimarySpacing parameter.
- o
SetGridVPrimarySpacing(double)
- Sets the Grid V Primary Spacing setting parameter value.
- o
SetGridVSecondaryStepLock(unsigned char)
- Locks or unlocks the GridVSecondaryStep parameter.
- o
SetGridVSecondaryStep(int)
- Sets the Grid V Secondary Spacing setting parameter value.
- o
SetLeaderAssociativityLock(unsigned char)
- Locks or unlocks the Leader Associativity parameter.
- o
SetLeaderAssociativity(unsigned char)
- Sets the Leader Associativity setting parameter value.
- o
SetManRefSizLock(unsigned char)
- Locks or unlocks the Manipulator reference size parameter.
- o
SetManRefSiz(double)
- Sets the Manipulator Reference Size setting parameter value.
- o
SetManZooCapLock(unsigned char)
- Locks or unlocks the Manipulator zoom capability parameter.
- o
SetManZooCap(unsigned char)
- Sets the Manipulator Zoom Capability Size setting parameter value.
- o
SetMoveAfterCreationLock(unsigned char)
- Locks or unlocks the Move After Creation parameter.
- o
SetMoveAfterCreation(unsigned char)
- Sets the Move After Creation setting parameter value.
- o
SetSaveInCGRLock(unsigned char)
- Locks or unlocks the Save In CGR parameter.
- o
SetSaveInCGR(unsigned char)
- Sets the Save in CGR setting parameter value.
- o
SetStandardLock(unsigned char)
- Locks or unlocks the Standard parameter.
- o
SetStandard(CATUnicodeString&)
- Sets the Standard setting parameter value.
- o
SetUnderFeatureLock(unsigned char)
- Locks or unlocks the UnderFeature Tree Visu parameter.
- o
SetUnderFeature(unsigned char)
- Sets the Under Feature setting parameter value.
- o
SetUnderSetLock(unsigned char)
- Locks or unlocks the UnderSet Tree Visu parameter.
- o
SetUnderSet(unsigned char)
- Sets the Under Set setting parameter value.
- o
SetUnderViewLock(unsigned char)
- Locks or unlocks the UnderView Tree Visu parameter.
- o
SetUnderView(unsigned char)
- Sets the Under View setting parameter value.
- o
SetViewAssociativityLock(unsigned char)
- Locks or unlocks the View associativity parameter.
- o
SetViewAssociativity(unsigned char)
- Sets the View Associativity setting parameter value.
- o
SetViewProfileLock(unsigned char)
- Locks or unlocks the View Profile parameter.
- o
SetViewProfile(unsigned char)
- Sets the View Profile setting parameter value.
- o
SetViewReferentialLock(unsigned char)
- Locks or unlocks the View Referential parameter.
- o
SetViewReferentialZoomableLock(unsigned char)
- Locks or unlocks the View Referential Zoomable parameter.
- o
SetViewReferentialZoomable(unsigned char)
- Sets the View Referential Zoomable setting parameter value.
- o
SetViewReferential(unsigned char)
- Sets the View Referential setting parameter value.
Methods
o GetAllowDistortionsInfo
| public virtual GetAllowDistortionsInfo( | | opInfo) |
-
Retrieves the state of the AllowDistortions parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetAllowDistortions
| public virtual GetAllowDistortions( | | oAllowDistortions) |
-
Retrieves the Allow Distortions setting parameter value.
Role: The Allow Distortions setting parameter allow a distorsion between vertical and horizontal.
- Parameters:
-
- oAllowDistortions
- [out] The Allow Distortions
- Returns:
- S_OK if the Allow Distortions setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetGridDisplayInfo
| public virtual GetGridDisplayInfo( | | opInfo) |
-
Retrieves the state of the GridDisplay parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridDisplay
| public virtual GetGridDisplay( | | oGridDisplay) |
-
Retrieves the Grid Display setting parameter value.
Role: The Grid Display setting parameter display a grid on the active to view
- Parameters:
-
- oGridDisplay
- [out] The Grid Display
- Returns:
- S_OK if the Grid Display setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetGridPrimarySpacingInfo
| public virtual GetGridPrimarySpacingInfo( | | opInfo) |
-
Retrieves the state of the GridPrimarySpacing parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridPrimarySpacing
| public virtual GetGridPrimarySpacing( | | oGridPrimarySpacing) |
-
Retrieves the Grid Primary Spacing setting parameter value.
Role: The Grid Primary Spacing setting parameter defines the spacing on the grid.
- Parameters:
-
- oGridPrimarySpacing
- [out] The Grid Primary Spacing
- Returns:
- S_OK if the Grid Primary Spacing setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetGridSecondaryStepInfo
| public virtual GetGridSecondaryStepInfo( | | opInfo) |
-
Retrieves the state of the GridSecondaryStep parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridSecondaryStep
| public virtual GetGridSecondaryStep( | | oGridSecondaryStep) |
-
Sets the Grid Secondary Spacing setting parameter value.
Role: The Grid Secondary Spacing setting parameter defines the number of case on the grid
- Parameters:
-
- oGridSecondaryStep
- [out] The Grid Secondary Spacing
- Returns:
- S_OK if the Grid Secondary Spacing setting parameter value
is successfully set, and E_FAIL otherwise
o GetGridSnapPointInfo
| public virtual GetGridSnapPointInfo( | | opInfo) |
-
Retrieves the state of the GridSnapPoint parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridSnapPoint
| public virtual GetGridSnapPoint( | | oGridSnapPoint) |
-
Retrieves the Grid Snap Point setting parameter value.
Role: The Grid Snap Point setting parameter force the annotation to be positionning on the grid.
- Parameters:
-
- oGridSnapPoint
- [out] The Grid Snap Point
- Returns:
- S_OK if the Grid Snap Point setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetGridVPrimarySpacingInfo
| public virtual GetGridVPrimarySpacingInfo( | | opInfo) |
-
Retrieves the state of the GridVPrimarySpacing parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridVPrimarySpacing
| public virtual GetGridVPrimarySpacing( | | oGridVPrimarySpacing) |
-
Retrieves the Grid V Primary Spacing setting parameter value.
Role: The Grid V Primary Spacing setting parameter defines the spacing on the grid on the second direction.
- Parameters:
-
- oGridVPrimarySpacing
- [out] The Grid V Primary Spacing
- Returns:
- S_OK if the Grid V Primary Spacing setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetGridVSecondaryStepInfo
| public virtual GetGridVSecondaryStepInfo( | | opInfo) |
-
Retrieves the state of the GridVSecondaryStep parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridVSecondaryStep
| public virtual GetGridVSecondaryStep( | | oGridVSecondaryStep) |
-
Retrieves the Grid V Secondary Spacing setting parameter value.
Role: The Grid V Secondary Spacing setting parameter defines the number of case on the grid on the second direction
- Parameters:
-
- oGridVSecondaryStep
- [out] The Grid V Secondary Spacing
- Returns:
- S_OK if the Grid V Secondary Spacing setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetLeaderAssociativityInfo
| public virtual GetLeaderAssociativityInfo( | | opInfo) |
-
Retrieves the state of the Leader Associativity parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLeaderAssociativity
| public virtual GetLeaderAssociativity( | | oLeaderAssociativity) |
-
Retrieves the Leader Associativity setting parameter value.
Role: The Leader Associativity setting parameter defines the associativity
of leader on a surface
Legal values:Undefined, Free, Perpendicular
- Parameters:
-
- oLeaderAssociativity
- [out] The Associativity
- Returns:
- S_OK if the Leader Associativity setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetManRefSizInfo
| public virtual GetManRefSizInfo( | | opInfo) |
-
Retrieves the state of the Manipulator reference size parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetManRefSiz
| public virtual GetManRefSiz( | | oManRefSiz) |
-
Retrieves the Manipulator Reference Size setting parameter value.
Role: The Manipulator Reference Size setting parameter defines the size of the manipulator
- Parameters:
-
- oValue
- [out] The Size of the Manipulator
- Returns:
- S_OK if the Manipulator Reference Size setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetManZooCapInfo
| public virtual GetManZooCapInfo( | | opInfo) |
-
Retrieves the state of the Manipulator zoom capability parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetManZooCap
| public virtual GetManZooCap( | | oManZooCap) |
-
Retrieves the Manipulator Zoom Capability Size setting parameter value.
Role: The Manipulator Zoom Capability setting parameter defines the capability of zoom on the manipulator.
- Parameters:
-
- oValue
- [out] The Manipulator Zoom Capability
- Returns:
- S_OK if the Manipulator Zoom Capability setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetMoveAfterCreationInfo
| public virtual GetMoveAfterCreationInfo( | | opInfo) |
-
Retrieves the state of the Move After Creation parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMoveAfterCreation
| public virtual GetMoveAfterCreation( | | oMoveAfterCreation) |
-
Retrieves the Move After Creation setting parameter value.
Role: The Move After Creation setting parameter defines capability to move the annotation after the creation.
- Parameters:
-
- oValue
- [out] The Move After Creation information
- Returns:
- S_OK if the Move After Creation setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetSaveInCGRInfo
| public virtual GetSaveInCGRInfo( | | opInfo) |
-
Retrieves the state of the Save In CGR parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSaveInCGR
| public virtual GetSaveInCGR( | | oSaveInCGR) |
-
Retrieves the Save in CGR setting parameter value.
Role: The Save in CGR setting parameter defines the save of annotations in CGR.
- Parameters:
-
- oValue
- [out] The Save in CGR information
- Returns:
- S_OK if the Standard setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetStandardInfo
| public virtual GetStandardInfo( | | opInfo) |
-
Retrieves the state of the Standard parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetStandard
| public virtual GetStandard( | | oStandard) |
-
Retrieves the Standard setting parameter value.
Role: The Standard setting parameter defines the standard of the annotation's set
Legal values:The three color indexes range from 0 to 255.
- Parameters:
-
- oStandard
- [out] The Standard
- Returns:
- S_OK if the Standard setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetUnderFeatureInfo
| public virtual GetUnderFeatureInfo( | | opInfo) |
-
Retrieves the state of the UnderFeature Tree Visu parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUnderFeature
| public virtual GetUnderFeature( | | oUnderFeature) |
-
Retrieves the Under Feature setting parameter value.
Role: The Under View setting parameter defines the annotations'
position in the 2D graph
- Parameters:
-
- oUnderFeature
- [out] The UnderFeature information
- Returns:
- S_OK if the UnderFeature setting parameter value
is successfully set, and E_FAIL otherwise
o GetUnderSetInfo
| public virtual GetUnderSetInfo( | | opInfo) |
-
Retrieves the state of the UnderSet Tree Visu parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUnderSet
| public virtual GetUnderSet( | | oUnderSet) |
-
Retrieves the Under Set setting parameter value.
Role: The Under Set setting parameter defines the annotations'
position in the 2D graph (under the annnotations' set)
- Parameters:
-
- oUnderSet
- [out] The UnderSet information
- Returns:
- S_OK if the UnderSet setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetUnderViewInfo
| public virtual GetUnderViewInfo( | | opInfo) |
-
Retrieves the state of the UnderView Tree Visu parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUnderView
| public virtual GetUnderView( | | oUnderView) |
-
Retrieves the Under View setting parameter value.
Role: The Under View setting parameter defines the annotations'
position in the 2D graph (under the 3D view)
- Parameters:
-
- oUnderView
- [out] The UnderView information
- Returns:
- S_OK if the UnderView setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetViewAssociativityInfo
| public virtual GetViewAssociativityInfo( | | opInfo) |
-
Retrieves the state of the View associativity parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewAssociativity
| public virtual GetViewAssociativity( | | oViewAssociativity) |
-
Retrieves the View Associativity setting parameter value.
Role: The View Associativity setting parameter defines the associativity of the view with the geometry.
- Parameters:
-
- oValue
- [out] The View Associativity information
- Returns:
- S_OK if the View Associativity setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetViewProfileInfo
| public virtual GetViewProfileInfo( | | opInfo) |
-
Retrieves the state of the View Profile parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewProfile
| public virtual GetViewProfile( | | oViewProfile) |
-
Retrieves the View Profile setting parameter value.
Role: The View Profile setting parameter defines the display or not of the profile of the view.
- Parameters:
-
- oValue
- [out] The oValue
- Returns:
- S_OK if the View Profile setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetViewReferentialInfo
| public virtual GetViewReferentialInfo( | | opInfo) |
-
Retrieves the state of the View Referential parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewReferentialZoomableInfo
| public virtual GetViewReferentialZoomableInfo( | | opInfo) |
-
Retrieves the state of the View Referential Zoomable parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewReferentialZoomable
| public virtual GetViewReferentialZoomable( | | oViewReferentialZoomable) |
-
Retrieves the View Referential Zoomable setting parameter value.
Role: The View Referential Zoomable setting parameter defines the capability to zoom ont he referential view.
- Parameters:
-
- oValue
- [out] The oValue
- Returns:
- S_OK if the View Referential Zoomable setting parameter value
is successfully retrieved, and E_FAIL otherwise
o GetViewReferential
| public virtual GetViewReferential( | | oViewReferential) |
-
Retrieves the View Referential setting parameter value.
Role: The View Referential setting parameter defines display or not the referential view.
- Parameters:
-
- oValue
- [out] The oValue
- Returns:
- S_OK if the View Referential setting parameter value
is successfully retrieved, and E_FAIL otherwise
o SetAllowDistortionsLock
| public virtual SetAllowDistortionsLock( | | iLocked) |
-
Locks or unlocks the AllowDistortions parameter.
Role: Locks or unlocks the AllowDistortions parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetAllowDistortions
| public virtual SetAllowDistortions( | | iAllowDistortions) |
-
Sets the Allow Distortions setting parameter value.
Role: The Allow Distortions setting parameter allow a distorsion between vertical and horizontal.
- Parameters:
-
- iAllowDistortions
- [in] The Allow Distortions
- Returns:
- S_OK if the Allow Distortions setting parameter value
is successfully set, and E_FAIL otherwise
o SetGridDisplayLock
| public virtual SetGridDisplayLock( | | iLocked) |
-
Locks or unlocks the GridDisplay parameter.
Role: Locks or unlocks the GridDisplay parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridDisplay
| public virtual SetGridDisplay( | | iGridDisplay) |
-
Sets the Grid Display setting parameter value.
Role: The Grid Display setting parameter display a grid on the active to view
- Parameters:
-
- iGridDisplay
- [in] The Grid Display
- Returns:
- S_OK if the Grid Display setting parameter value
is successfully set, and E_FAIL otherwise
o SetGridPrimarySpacingLock
| public virtual SetGridPrimarySpacingLock( | | iLocked) |
-
Locks or unlocks the GridPrimarySpacing parameter.
Role: Locks or unlocks the GridPrimarySpacing parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridPrimarySpacing
| public virtual SetGridPrimarySpacing( | | iGridPrimarySpacing) |
-
Sets the Grid Primary Spacing setting parameter value.
Role: The Grid Primary Spacing setting parameter defines the spacing on the grid.
- Parameters:
-
- iGridPrimarySpacing
- [in] The Grid Primary Spacing
- Returns:
- S_OK if the Grid Primary Spacing setting parameter value
is successfully set, and E_FAIL otherwise
o SetGridSecondaryStepLock
| public virtual SetGridSecondaryStepLock( | | iLocked) |
-
Locks or unlocks the GridSecondaryStep parameter.
Role: Locks or unlocks the GridSecondaryStep parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridSecondaryStep
| public virtual SetGridSecondaryStep( | | iGridSecondaryStep) |
-
Sets the Grid Secondary Spacing setting parameter value.
Role: The Grid Secondary Spacing setting parameter defines the number of case on the grid
- Parameters:
-
- iGridSecondaryStep
- [in] The Grid Secondary Spacing
- Returns:
- S_OK if the Grid Secondary Spacing setting parameter value
is successfully set, and E_FAIL otherwise
o SetGridSnapPointLock
| public virtual SetGridSnapPointLock( | | iLocked) |
-
Locks or unlocks the GridSnapPoint parameter.
Role: Locks or unlocks the GridSnapPoint parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridSnapPoint
| public virtual SetGridSnapPoint( | | iGridSnapPoint) |
-
Sets the Grid Snap Point setting parameter value.
Role: The Grid Snap Point setting parameter force the annotation to be positionning on the grid.
- Parameters:
-
- iGridSnapPoint
- [in] The Grid Snap Point
- Returns:
- S_OK if the Grid Snap Point setting parameter value
is successfully set, and E_FAIL otherwise
o SetGridVPrimarySpacingLock
| public virtual SetGridVPrimarySpacingLock( | | iLocked) |
-
Locks or unlocks the GridVPrimarySpacing parameter.
Role: Locks or unlocks the GridVPrimarySpacing parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridVPrimarySpacing
| public virtual SetGridVPrimarySpacing( | | iGridVPrimarySpacing) |
-
Sets the Grid V Primary Spacing setting parameter value.
Role: The Grid V Primary Spacing setting parameter defines the spacing on the grid on the second direction.
- Parameters:
-
- iGridVPrimarySpacing
- [in] The Grid V Primary Spacing
- Returns:
- S_OK if the Grid V Primary Spacing setting parameter value
is successfully set, and E_FAIL otherwise
o SetGridVSecondaryStepLock
| public virtual SetGridVSecondaryStepLock( | | iLocked) |
-
Locks or unlocks the GridVSecondaryStep parameter.
Role: Locks or unlocks the GridVSecondaryStep parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridVSecondaryStep
| public virtual SetGridVSecondaryStep( | | iGridVSecondaryStep) |
-
Sets the Grid V Secondary Spacing setting parameter value.
Role: The Grid V Secondary Spacing setting parameter defines the number of case on the grid on the second direction
- Parameters:
-
- iGridVSecondaryStep
- [in] The Grid V Secondary Spacing
- Returns:
- S_OK if the Grid V Secondary Spacing setting parameter value
is successfully set, and E_FAIL otherwise
o SetLeaderAssociativityLock
| public virtual SetLeaderAssociativityLock( | | iLocked) |
-
Locks or unlocks the Leader Associativity parameter.
Role: Locks or unlocks the Leader Associativity parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLeaderAssociativity
| public virtual SetLeaderAssociativity( | | iLeaderAssociativity) |
-
Sets the Leader Associativity setting parameter value.
Role: The Leader Associativity setting parameter defines the associativity
of leader on a surface
Legal values:Undefined, Free, Perpendicular
- Parameters:
-
- iLeaderAssociativity
- [in] The Associativity
- Returns:
- S_OK if the Leader Associativity setting parameter value
is successfully set, and E_FAIL otherwise
o SetManRefSizLock
| public virtual SetManRefSizLock( | | iLocked) |
-
Locks or unlocks the Manipulator reference size parameter.
Role: Locks or unlocks the Manipulator reference size parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetManRefSiz
| public virtual SetManRefSiz( | | iManRefSiz) |
-
Sets the Manipulator Reference Size setting parameter value.
Role: The Manipulator Reference Size setting parameter defines the size of the manipulator.
- Parameters:
-
- iValue
- [in] The Size of the Manipulator
- Returns:
- S_OK if the Manipulator Reference Size setting parameter value
is successfully set, and E_FAIL otherwise
o SetManZooCapLock
| public virtual SetManZooCapLock( | | iLocked) |
-
Locks or unlocks the Manipulator zoom capability parameter.
Role: Locks or unlocks the Manipulator zoom capability parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetManZooCap
| public virtual SetManZooCap( | | iManZooCap) |
-
Sets the Manipulator Zoom Capability Size setting parameter value.
Role: The Manipulator Zoom Capability setting parameter defines the capability of zoom on the manipulator.
- Parameters:
-
- iValue
- [in] The Manipulator Zoom Capability
- Returns:
- S_OK if the Manipulator Zoom Capability setting parameter value
is successfully set, and E_FAIL otherwise
o SetMoveAfterCreationLock
| public virtual SetMoveAfterCreationLock( | | iLocked) |
-
Locks or unlocks the Move After Creation parameter.
Role: Locks or unlocks the Move After Creation parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMoveAfterCreation
| public virtual SetMoveAfterCreation( | | iMoveAfterCreation) |
-
Sets the Move After Creation setting parameter value.
Role: The Move After Creation setting parameter defines capability to move the annotation after the creation.
- Parameters:
-
- iValue
- [in] The Move After Creation information
- Returns:
- S_OK if the Move After Creation setting parameter value
is successfully set, and E_FAIL otherwise
o SetSaveInCGRLock
| public virtual SetSaveInCGRLock( | | iLocked) |
-
Locks or unlocks the Save In CGR parameter.
Role: Locks or unlocks the Save In CGR parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSaveInCGR
| public virtual SetSaveInCGR( | | iSaveInCGR) |
-
Sets the Save in CGR setting parameter value.
Role: The Save in CGR setting parameter defines the save of annotations in CGR.
- Parameters:
-
- iValue
- [in] The Save in CGR information
- Returns:
- S_OK if the Save In CGR setting parameter value
is successfully set, and E_FAIL otherwise
o SetStandardLock
| public virtual SetStandardLock( | | iLocked) |
-
Locks or unlocks the Standard parameter.
Role: Locks or unlocks the Standard parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetStandard
| public virtual SetStandard( | | iStandard) |
-
Sets the Standard setting parameter value.
Role: The Standard setting parameter defines the standard of the annotation's set
- Parameters:
-
- iStandard
- [in] The Standard
- Returns:
- S_OK if the Standard setting parameter value
is successfully retrieved, and E_FAIL otherwise
o SetUnderFeatureLock
| public virtual SetUnderFeatureLock( | | iLocked) |
-
Locks or unlocks the UnderFeature Tree Visu parameter.
Role: Locks or unlocks the UnderFeature Tree Visu parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetUnderFeature
| public virtual SetUnderFeature( | | iUnderFeature) |
-
Sets the Under Feature setting parameter value.
Role: The Under View setting parameter defines the annotations'
position in the 2D graph
- Parameters:
-
- iUnderFeature
- [in] The UnderFeature information
- Returns:
- S_OK if the UnderFeature setting parameter value
is successfully set, and E_FAIL otherwise
o SetUnderSetLock
| public virtual SetUnderSetLock( | | iLocked) |
-
Locks or unlocks the UnderSet Tree Visu parameter.
Role: Locks or unlocks the UnderSet Tree Visu parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetUnderSet
| public virtual SetUnderSet( | | iUnderSet) |
-
Sets the Under Set setting parameter value.
Role: The Under Set setting parameter defines the annotations'
position in the 2D graph (under the annnotations' set)
- Parameters:
-
- iUnderSet
- [in] The UnderSet information
- Returns:
- S_OK if the UnderSet setting parameter value
is successfully set, and E_FAIL otherwise
o SetUnderViewLock
| public virtual SetUnderViewLock( | | iLocked) |
-
Locks or unlocks the UnderView Tree Visu parameter.
Role: Locks or unlocks the UnderView Tree Visu parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetUnderView
| public virtual SetUnderView( | | iUnderView) |
-
Sets the Under View setting parameter value.
Role: The Under View setting parameter defines the annotations'
position in the 2D graph (under the 3D view)
- Parameters:
-
- iUnderView
- [in] The UnderView information
- Returns:
- S_OK if the UnderView setting parameter value
is successfully set, and E_FAIL otherwise
o SetViewAssociativityLock
| public virtual SetViewAssociativityLock( | | iLocked) |
-
Locks or unlocks the View associativity parameter.
Role: Locks or unlocks the View associativity parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewAssociativity
| public virtual SetViewAssociativity( | | iViewAssociativity) |
-
Sets the View Associativity setting parameter value.
Role: The View Associativity setting parameter defines the associativity of the view with the geometry.
- Parameters:
-
- oValue
- [out] The View Associativity information
- Returns:
- S_OK if the View Associativity setting parameter value
is successfully set, and E_FAIL otherwise
o SetViewProfileLock
| public virtual SetViewProfileLock( | | iLocked) |
-
Locks or unlocks the View Profile parameter.
Role: Locks or unlocks the View Profile parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewProfile
| public virtual SetViewProfile( | | iViewProfile) |
-
Sets the View Profile setting parameter value.
Role: The View Profile setting parameter defines the display or not of the profile of the view.
- Parameters:
-
- iValue
- [in] The iValue
- Returns:
- S_OK if the View Profile setting parameter value
is successfully set, and E_FAIL otherwise
o SetViewReferentialLock
| public virtual SetViewReferentialLock( | | iLocked) |
-
Locks or unlocks the View Referential parameter.
Role: Locks or unlocks the View Referential parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewReferentialZoomableLock
| public virtual SetViewReferentialZoomableLock( | | iLocked) |
-
Locks or unlocks the View Referential Zoomable parameter.
Role: Locks or unlocks the View Referential Zoomable parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewReferentialZoomable
| public virtual SetViewReferentialZoomable( | | iViewReferentialZoomable) |
-
Sets the View Referential Zoomable setting parameter value.
Role: The View Referential Zoomable setting parameter defines the capability to zoom ont he referential view.
- Parameters:
-
- iValue
- [in] The iValue
- Returns:
- S_OK if the View Referential Zoomable setting parameter value
is successfully retrieved, and E_FAIL otherwise
o SetViewReferential
| public virtual SetViewReferential( | | iViewReferential) |
-
Sets the View Referential setting parameter value.
Role: The View Referential setting parameter defines display or not the referential view.
- Parameters:
-
- iValue
- [in] The oValue
- Returns:
- S_OK if the View Referential setting parameter value
is successfully set, and E_FAIL otherwise
This object is included in the file: CATITPSEditorUIFTAInfraSettingAtt.h
If needed, your Imakefile.mk should include the module: CATTPSItf