All Frameworks Class Hierarchy This Framework Indexes
NavigatorInterfaces Interface CATIDMUN4DNavigatorSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDMUN4DNavigatorSettingAtt
Interface to handle the parameters of the DMU Navigator workbench.
Role: This interface is implemented by a component which
represents the controller of DMU Navigator settings.
This interface defines:
- A method to set each parameter
- A method to get the value of each parameter
- A method to lock/unlock each parameter
- A method to retrieve the informations concerning each parameter
Method Index
- o
GetClearanceVoxelInfo(CATSettingInfo*)
- Retrieves the state of the parameter ClearanceVoxel.
- o
GetClearanceVoxel(float&)
- Retrieves the ClearanceVoxel value.
- o
GetDMUClashPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUClashPreview.
- o
GetDMUClashPreview(unsigned char&)
- Retrieves the DMUClashPreview activation state.
- o
GetDMUCut3DPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUCut3DPreview.
- o
GetDMUCut3DPreview(unsigned char&)
- Retrieves the DMUCut3DPreview activation state.
- o
GetDMUDistancePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUDistancePreview.
- o
GetDMUDistancePreview(unsigned char&)
- Retrieves the DMUDistancePreview activation state.
- o
GetDMUFreeSpacePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUFreeSpacePreview.
- o
GetDMUFreeSpacePreview(unsigned char&)
- Retrieves the DMUFreeSpacePreview activation state.
- o
GetDMUGroupPreviewHiddenObjectsColorInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsColor.
- o
GetDMUGroupPreviewHiddenObjectsColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the DMUGroupPreviewHiddenObjectsColor values.
- o
GetDMUGroupPreviewHiddenObjectsDisplayModeInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsDisplayMode.
- o
GetDMUGroupPreviewHiddenObjectsDisplayMode(unsigned int&)
- Retrieves the DMUGroupPreviewHiddenObjectsDisplayMode state.
- o
GetDMUGroupPreviewHiddenObjectsLowIntInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsLowInt.
- o
GetDMUGroupPreviewHiddenObjectsLowInt(unsigned char&)
- Retrieves the DMUGroupPreviewHiddenObjectsLowInt activation state.
- o
GetDMUGroupPreviewHiddenObjectsOpacityInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsOpacity.
- o
GetDMUGroupPreviewHiddenObjectsOpacity(unsigned int&)
- Retrieves the DMUGroupPreviewHiddenObjectsOpacity value.
- o
GetDMUGroupPreviewHiddenObjectsPickInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsPick.
- o
GetDMUGroupPreviewHiddenObjectsPick(unsigned char&)
- Retrieves the DMUGroupPreviewHiddenObjectsPick activation state.
- o
GetDMUGroupPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreview.
- o
GetDMUGroupPreview(unsigned char&)
- Retrieves the DMUGroupPreview activation state.
- o
GetDMUMergerPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUMergerPreview.
- o
GetDMUMergerPreview(unsigned char&)
- Retrieves the DMUMergerPreview activation state.
- o
GetDMUOffsetPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUOffsetPreview.
- o
GetDMUOffsetPreview(unsigned char&)
- Retrieves the DMUOffsetPreview activation state.
- o
GetDMUReviewNameInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUReviewName.
- o
GetDMUReviewName(CATUnicodeString&)
- Retrieves the DMUReviewName name.
- o
GetDMUSectionPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSectionPreview.
- o
GetDMUSectionPreview(unsigned char&)
- Retrieves the DMUSectionPreview activation state.
- o
GetDMUShuttlePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUShuttlePreview.
- o
GetDMUShuttlePreview(unsigned char&)
- Retrieves the DMUShuttlePreview activation state.
- o
GetDMUSilhouettePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSilhouettePreview.
- o
GetDMUSilhouettePreview(unsigned char&)
- Retrieves the DMUSilhouettePreview activation state.
- o
GetDMUSimplifPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSimplifPreview.
- o
GetDMUSimplifPreview(unsigned char&)
- Retrieves the DMUSimplifPreview activation state.
- o
GetDMUSweptVolPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSweptVolPreview.
- o
GetDMUSweptVolPreview(unsigned char&)
- Retrieves the DMUSweptVolPreview activation state.
- o
GetDMUThicknessPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUThicknessPreview.
- o
GetDMUThicknessPreview(unsigned char&)
- Retrieves the DMUThicknessPreview activation state.
- o
GetDMUVibrationVolPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUVibrationVolPreview.
- o
GetDMUVibrationVolPreview(unsigned char&)
- Retrieves the DMUVibrationVolPreview activation state.
- o
GetDMUWrappingPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUWrappingPreview.
- o
GetDMUWrappingPreview(unsigned char&)
- Retrieves the DMUWrappingPreview activation state.
- o
GetForceClearanceVoxelInfo(CATSettingInfo*)
- Retrieves the state of the parameter ForceClearanceVoxel.
- o
GetForceClearanceVoxel(unsigned char&)
- Retrieves the ForceClearanceVoxel activation state.
- o
GetForceVoxelInfo(CATSettingInfo*)
- Retrieves the state of the parameter ForceVoxel.
- o
GetForceVoxel(unsigned char&)
- Retrieves the ForceVoxel activation state.
- o
GetInsertLevelInfo(CATSettingInfo*)
- Retrieves the state of the parameter InsertLevel.
- o
GetInsertLevel(int&)
- Retrieves the InsertLevel state.
- o
GetInsertModeInfo(CATSettingInfo*)
- Retrieves the state of the parameter InsertMode.
- o
GetInsertMode(int&)
- Retrieves the InsertMode state.
- o
GetMarker2DAutoNamingInfo(CATSettingInfo*)
-
- o
GetMarker2DAutoNaming(unsigned char&)
-
- o
GetMarker3DAutoNamingInfo(CATSettingInfo*)
-
- o
GetMarker3DAutoNaming(unsigned char&)
-
- o
GetMarkerAutoUpdateInfo(CATSettingInfo*)
- Retrieves the state of the parameter MarkerAutoUpdate.
- o
GetMarkerAutoUpdate(unsigned char&)
- Retrieves the MarkerAutoUpdate activation state.
- o
GetMarkerDefaultsColorInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsColor(unsigned int&,unsigned int&,unsigned int&)
-
- o
GetMarkerDefaultsDashedInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsDashed(unsigned int&)
-
- o
GetMarkerDefaultsFontInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsFont(CATUnicodeString&)
-
- o
GetMarkerDefaultsSizeInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsSize(float&)
-
- o
GetMarkerDefaultsWeightInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsWeight(unsigned int&)
-
- o
GetMarkerTextColorInfo(CATSettingInfo*)
-
- o
GetMarkerTextColor(unsigned int&,unsigned int&,unsigned int&)
-
- o
GetMarkerTextDashedInfo(CATSettingInfo*)
-
- o
GetMarkerTextDashed(unsigned int&)
-
- o
GetMarkerTextWeightInfo(CATSettingInfo*)
-
- o
GetMarkerTextWeight(unsigned int&)
-
- o
GetNumUrlNameInfo(CATSettingInfo*)
- Retrieves the state of the parameter NumUrlName.
- o
GetNumUrlName(unsigned char&)
- Retrieves the NumUrlName activation state.
- o
GetPublishAutoLaunchBrowserInfo(CATSettingInfo*)
- Retrieves the state of the parameter PublishAutoLaunchBrowser.
- o
GetPublishAutoLaunchBrowser(unsigned char&)
- Retrieves the PublishAutoLaunchBrowser activation state.
- o
GetSceneDefaultsColorInfo(CATSettingInfo*)
- Retrieves the state of the parameter SceneDefaultsColor.
- o
GetSceneDefaultsColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the SceneDefaultsColor values.
- o
SetClearanceVoxelLock(unsigned char)
- Locks or unlocks the ClearanceVoxel parameter.
- o
SetClearanceVoxel(float)
- Set the ClearanceVoxel value.
- o
SetDMUClashPreviewLock(unsigned char)
- Locks or unlocks the DMUClashPreview parameter.
- o
SetDMUClashPreview(unsigned char)
- Turns ON/OFF the DMUClashPreview activation.
- o
SetDMUCut3DPreviewLock(unsigned char)
- Locks or unlocks the DMUCut3DPreview parameter.
- o
SetDMUCut3DPreview(unsigned char)
- Turns ON/OFF the DMUCut3DPreview activation.
- o
SetDMUDistancePreviewLock(unsigned char)
- Locks or unlocks the DMUDistancePreview parameter.
- o
SetDMUDistancePreview(unsigned char)
- Turns ON/OFF the DMUDistancePreview activation.
- o
SetDMUFreeSpacePreviewLock(unsigned char)
- Locks or unlocks the DMUFreeSpacePreview parameter.
- o
SetDMUFreeSpacePreview(unsigned char)
- Turns ON/OFF the DMUFreeSpacePreview activation.
- o
SetDMUGroupPreviewHiddenObjectsColorLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsColor parameter.
- o
SetDMUGroupPreviewHiddenObjectsColor(unsigned int,unsigned int,unsigned int)
- Set the DMUGroupPreviewHiddenObjectsColor values.
- o
SetDMUGroupPreviewHiddenObjectsDisplayModeLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsDisplayMode parameter.
- o
SetDMUGroupPreviewHiddenObjectsDisplayMode(unsigned int)
- Sets the DMUGroupPreviewHiddenObjectsDisplayMode state.
- o
SetDMUGroupPreviewHiddenObjectsLowIntLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsLowInt parameter.
- o
SetDMUGroupPreviewHiddenObjectsLowInt(unsigned char)
- Turns ON/OFF the DMUGroupPreviewHiddenObjectsLowInt activation.
- o
SetDMUGroupPreviewHiddenObjectsOpacityLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsOpacity parameter.
- o
SetDMUGroupPreviewHiddenObjectsOpacity(unsigned int)
- Set the DMUGroupPreviewHiddenObjectsoOpacity values.
- o
SetDMUGroupPreviewHiddenObjectsPickLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsPick parameter.
- o
SetDMUGroupPreviewHiddenObjectsPick(unsigned char)
- Turns ON/OFF the DMUGroupPreviewHiddenObjectsPick activation.
- o
SetDMUGroupPreviewLock(unsigned char)
- Locks or unlocks the DMUGroupPreview parameter.
- o
SetDMUGroupPreview(unsigned char)
- Turns ON/OFF the DMUGroupPreview activation.
- o
SetDMUMergerPreviewLock(unsigned char)
- Locks or unlocks the DMUMergerPreview parameter.
- o
SetDMUMergerPreview(unsigned char)
- Turns ON/OFF the DMUMergerPreview activation.
- o
SetDMUOffsetPreviewLock(unsigned char)
- Locks or unlocks the DMUOffsetPreview parameter.
- o
SetDMUOffsetPreview(unsigned char)
- Turns ON/OFF the DMUOffsetPreview activation.
- o
SetDMUReviewNameLock(unsigned char)
- Locks or unlocks the DMUReviewName parameter.
- o
SetDMUReviewName(CATUnicodeString)
- Set the DMUReviewName value.
- o
SetDMUSectionPreviewLock(unsigned char)
- Locks or unlocks the DMUSectionPreview parameter.
- o
SetDMUSectionPreview(unsigned char)
- Turns ON/OFF the DMUSectionPreview activation.
- o
SetDMUShuttlePreviewLock(unsigned char)
- Locks or unlocks the DMUShuttlePreview parameter.
- o
SetDMUShuttlePreview(unsigned char)
- Turns ON/OFF the DMUShuttlePreview activation.
- o
SetDMUSilhouettePreviewLock(unsigned char)
- Locks or unlocks the DMUSilhouettePreview parameter.
- o
SetDMUSilhouettePreview(unsigned char)
- Turns ON/OFF the DMUSilhouettePreview activation.
- o
SetDMUSimplifPreviewLock(unsigned char)
- Locks or unlocks the DMUSimplifPreview parameter.
- o
SetDMUSimplifPreview(unsigned char)
- Turns ON/OFF the DMUSimplifPreview activation.
- o
SetDMUSweptVolPreviewLock(unsigned char)
- Locks or unlocks the DMUSweptVolPreview parameter.
- o
SetDMUSweptVolPreview(unsigned char)
- Turns ON/OFF the DMUSweptVolPreview activation.
- o
SetDMUThicknessPreviewLock(unsigned char)
- Locks or unlocks the DMUThicknessPreview parameter.
- o
SetDMUThicknessPreview(unsigned char)
- Turns ON/OFF the DMUThicknessPreview activation.
- o
SetDMUVibrationVolPreviewLock(unsigned char)
- Locks or unlocks the DMUVibrationVolPreview parameter.
- o
SetDMUVibrationVolPreview(unsigned char)
- Turns ON/OFF the DMUVibrationVolPreview activation.
- o
SetDMUWrappingPreviewLock(unsigned char)
- Locks or unlocks the DMUWrappingPreview parameter.
- o
SetDMUWrappingPreview(unsigned char)
- Turns ON/OFF the DMUWrappingPreview activation.
- o
SetForceClearanceVoxelLock(unsigned char)
- Locks or unlocks the ForceClearanceVoxel parameter.
- o
SetForceClearanceVoxel(unsigned char)
- Turns ON/OFF the ForceClearanceVoxel activation.
- o
SetForceVoxelLock(unsigned char)
- Locks or unlocks the ForceVoxel parameter.
- o
SetForceVoxel(unsigned char)
- Turns ON/OFF the ForceVoxel activation.
- o
SetInsertLevelLock(unsigned char)
- Locks or unlocks the InsertLevel parameter.
- o
SetInsertLevel(int)
- Turns ON/OFF the InsertLevel activation.
- o
SetInsertModeLock(unsigned char)
- Locks or unlocks the InsertMode parameter.
- o
SetInsertMode(int)
- Turns ON/OFF the InsertMode activation.
- o
SetMarker2DAutoNamingLock(unsigned char)
-
- o
SetMarker2DAutoNaming(unsigned char)
-
- o
SetMarker3DAutoNamingLock(unsigned char)
-
- o
SetMarker3DAutoNaming(unsigned char)
-
- o
SetMarkerAutoUpdateLock(unsigned char)
- Locks or unlocks the MarkerAutoUpdate parameter.
- o
SetMarkerAutoUpdate(unsigned char)
- Turns ON/OFF the MarkerAutoUpdate activation.
- o
SetMarkerDefaultsColorLock(unsigned char)
-
- o
SetMarkerDefaultsColor(unsigned int,unsigned int,unsigned int)
-
- o
SetMarkerDefaultsDashedLock(unsigned char)
-
- o
SetMarkerDefaultsDashed(unsigned int)
-
- o
SetMarkerDefaultsFontLock(unsigned char)
-
- o
SetMarkerDefaultsFont(CATUnicodeString)
-
- o
SetMarkerDefaultsSizeLock(unsigned char)
-
- o
SetMarkerDefaultsSize(float)
-
- o
SetMarkerDefaultsWeightLock(unsigned char)
-
- o
SetMarkerDefaultsWeight(unsigned int)
-
- o
SetMarkerTextColorLock(unsigned char)
-
- o
SetMarkerTextColor(unsigned int,unsigned int,unsigned int)
-
- o
SetMarkerTextDashedLock(unsigned char)
-
- o
SetMarkerTextDashed(unsigned int)
-
- o
SetMarkerTextWeightLock(unsigned char)
-
- o
SetMarkerTextWeight(unsigned int)
-
- o
SetNumUrlNameLock(unsigned char)
- Locks or unlocks the NumUrlName parameter.
- o
SetNumUrlName(unsigned char)
- Turns ON/OFF the NumUrlName activation.
- o
SetPublishAutoLaunchBrowserLock(unsigned char)
- Locks or unlocks the PublishAutoLaunchBrowser parameter.
- o
SetPublishAutoLaunchBrowser(unsigned char)
- Turns ON/OFF the PublishAutoLaunchBrowser activation.
- o
SetSceneDefaultsColorLock(unsigned char)
- Locks or unlocks the SceneDefaultsColor parameter.
- o
SetSceneDefaultsColor(unsigned int,unsigned int,unsigned int)
- Set the SceneDefaultsColor values.
Methods
o GetClearanceVoxelInfo
| public virtual GetClearanceVoxelInfo( | | oInfo) |
-
Retrieves the state of the parameter ClearanceVoxel.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClearanceVoxel
| public virtual GetClearanceVoxel( | | oValue) |
-
Retrieves the ClearanceVoxel value.
- Parameters:
-
- oValue
- the clearance value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUClashPreviewInfo
| public virtual GetDMUClashPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUClashPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUClashPreview
| public virtual GetDMUClashPreview( | | oMode) |
-
Retrieves the DMUClashPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUCut3DPreviewInfo
| public virtual GetDMUCut3DPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUCut3DPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUCut3DPreview
| public virtual GetDMUCut3DPreview( | | oMode) |
-
Retrieves the DMUCut3DPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUDistancePreviewInfo
| public virtual GetDMUDistancePreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUDistancePreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUDistancePreview
| public virtual GetDMUDistancePreview( | | oMode) |
-
Retrieves the DMUDistancePreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUFreeSpacePreviewInfo
| public virtual GetDMUFreeSpacePreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUFreeSpacePreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUFreeSpacePreview
| public virtual GetDMUFreeSpacePreview( | | oMode) |
-
Retrieves the DMUFreeSpacePreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsColorInfo
| public virtual GetDMUGroupPreviewHiddenObjectsColorInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsColor.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsColor
| public virtual GetDMUGroupPreviewHiddenObjectsColor( | | oR, |
| | oG, |
| | oB) |
-
Retrieves the DMUGroupPreviewHiddenObjectsColor values.
- Parameters:
-
- oR
- the red value
- oG
- the green value
- oB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsDisplayModeInfo
| public virtual GetDMUGroupPreviewHiddenObjectsDisplayModeInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsDisplayMode.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsDisplayMode
| public virtual GetDMUGroupPreviewHiddenObjectsDisplayMode( | | oMode) |
-
Retrieves the DMUGroupPreviewHiddenObjectsDisplayMode state.
- Parameters:
-
- oMode
- Legal values:
0: same display as in main viewer
1: with customized graphic properties
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsLowIntInfo
| public virtual GetDMUGroupPreviewHiddenObjectsLowIntInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsLowInt.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsLowInt
| public virtual GetDMUGroupPreviewHiddenObjectsLowInt( | | oMode) |
-
Retrieves the DMUGroupPreviewHiddenObjectsLowInt activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsOpacityInfo
| public virtual GetDMUGroupPreviewHiddenObjectsOpacityInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsOpacity.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsOpacity
| public virtual GetDMUGroupPreviewHiddenObjectsOpacity( | | oOpacity) |
-
Retrieves the DMUGroupPreviewHiddenObjectsOpacity value.
- Parameters:
-
- oOpacity
- the opacity value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsPickInfo
| public virtual GetDMUGroupPreviewHiddenObjectsPickInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsPick.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsPick
| public virtual GetDMUGroupPreviewHiddenObjectsPick( | | oMode) |
-
Retrieves the DMUGroupPreviewHiddenObjectsPick activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewInfo
| public virtual GetDMUGroupPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUGroupPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreview
| public virtual GetDMUGroupPreview( | | oMode) |
-
Retrieves the DMUGroupPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUMergerPreviewInfo
| public virtual GetDMUMergerPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUMergerPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUMergerPreview
| public virtual GetDMUMergerPreview( | | oMode) |
-
Retrieves the DMUMergerPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUOffsetPreviewInfo
| public virtual GetDMUOffsetPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUOffsetPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUOffsetPreview
| public virtual GetDMUOffsetPreview( | | oMode) |
-
Retrieves the DMUOffsetPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUReviewNameInfo
| public virtual GetDMUReviewNameInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUReviewName.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUReviewName
| public virtual GetDMUReviewName( | | oName) |
-
Retrieves the DMUReviewName name.
- Parameters:
-
- oName
- the DMU Review name
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSectionPreviewInfo
| public virtual GetDMUSectionPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUSectionPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSectionPreview
| public virtual GetDMUSectionPreview( | | oMode) |
-
Retrieves the DMUSectionPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUShuttlePreviewInfo
| public virtual GetDMUShuttlePreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUShuttlePreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUShuttlePreview
| public virtual GetDMUShuttlePreview( | | oMode) |
-
Retrieves the DMUShuttlePreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSilhouettePreviewInfo
| public virtual GetDMUSilhouettePreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUSilhouettePreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSilhouettePreview
| public virtual GetDMUSilhouettePreview( | | oMode) |
-
Retrieves the DMUSilhouettePreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSimplifPreviewInfo
| public virtual GetDMUSimplifPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUSimplifPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSimplifPreview
| public virtual GetDMUSimplifPreview( | | oMode) |
-
Retrieves the DMUSimplifPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSweptVolPreviewInfo
| public virtual GetDMUSweptVolPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUSweptVolPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUSweptVolPreview
| public virtual GetDMUSweptVolPreview( | | oMode) |
-
Retrieves the DMUSweptVolPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUThicknessPreviewInfo
| public virtual GetDMUThicknessPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUThicknessPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUThicknessPreview
| public virtual GetDMUThicknessPreview( | | oMode) |
-
Retrieves the DMUThicknessPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUVibrationVolPreviewInfo
| public virtual GetDMUVibrationVolPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUVibrationVolPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUVibrationVolPreview
| public virtual GetDMUVibrationVolPreview( | | oMode) |
-
Retrieves the DMUVibrationVolPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUWrappingPreviewInfo
| public virtual GetDMUWrappingPreviewInfo( | | oInfo) |
-
Retrieves the state of the parameter DMUWrappingPreview.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUWrappingPreview
| public virtual GetDMUWrappingPreview( | | oMode) |
-
Retrieves the DMUWrappingPreview activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetForceClearanceVoxelInfo
| public virtual GetForceClearanceVoxelInfo( | | oInfo) |
-
Retrieves the state of the parameter ForceClearanceVoxel.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetForceClearanceVoxel
| public virtual GetForceClearanceVoxel( | | oMode) |
-
Retrieves the ForceClearanceVoxel activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetForceVoxelInfo
| public virtual GetForceVoxelInfo( | | oInfo) |
-
Retrieves the state of the parameter ForceVoxel.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetForceVoxel
| public virtual GetForceVoxel( | | oMode) |
-
Retrieves the ForceVoxel activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInsertLevelInfo
| public virtual GetInsertLevelInfo( | | oInfo) |
-
Retrieves the state of the parameter InsertLevel.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInsertLevel
| public virtual GetInsertLevel( | | oLevel) |
-
Retrieves the InsertLevel state.
- Parameters:
-
- oLevel
- Legal values:
0: insert is done in current review
1: insert is done at highest level
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInsertModeInfo
| public virtual GetInsertModeInfo( | | oInfo) |
-
Retrieves the state of the parameter InsertMode.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetInsertMode
| public virtual GetInsertMode( | | oMode) |
-
Retrieves the InsertMode state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on with automatic import of applicative data
2: turned on with user prompt
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarker2DAutoNamingInfo
| public virtual GetMarker2DAutoNamingInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarker2DAutoNamingInfo Retrieves the state of the parameter Marker2DAutoNaming.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarker2DAutoNaming
| public virtual GetMarker2DAutoNaming( | | oMode) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarker2DAutoNaming Retrieves the Marker2DAutoNaming activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarker3DAutoNamingInfo
| public virtual GetMarker3DAutoNamingInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarker3DAutoNamingInfo Retrieves the state of the parameter Marker3DAutoNaming.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarker3DAutoNaming
| public virtual GetMarker3DAutoNaming( | | oMode) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarker3DAutoNaming Retrieves the Marker3DAutoNaming activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerAutoUpdateInfo
| public virtual GetMarkerAutoUpdateInfo( | | oInfo) |
-
Retrieves the state of the parameter MarkerAutoUpdate.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerAutoUpdate
| public virtual GetMarkerAutoUpdate( | | oMode) |
-
Retrieves the MarkerAutoUpdate activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsColorInfo
| public virtual GetMarkerDefaultsColorInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerDefaultsColorInfo Retrieves the state of the parameter MarkerDefaultsColor.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsColor
| public virtual GetMarkerDefaultsColor( | | oR, |
| | oG, |
| | oB) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerDefaultsColor Retrieves the MarkerDefaultsColor values.
- Parameters:
-
- oR
- the red value
- oG
- the green value
- oB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsDashedInfo
| public virtual GetMarkerDefaultsDashedInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerDefaultsDashedInfo Retrieves the state of the parameter MarkerDefaultsDashed.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsDashed
| public virtual GetMarkerDefaultsDashed( | | oValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerDefaultsDashed Retrieves the MarkerDefaultsDashed value.
- Parameters:
-
- oValue
- the marker default dashed value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsFontInfo
| public virtual GetMarkerDefaultsFontInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextDefaultsFont2DInfo Retrieves the state of the parameter MarkerDefaultsFont.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsFont
| public virtual GetMarkerDefaultsFont( | | oFont) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextDefaultsFont2D Retrieves the MarkerDefaultsFont value.
- Parameters:
-
- oFont
- the marker default font
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsSizeInfo
| public virtual GetMarkerDefaultsSizeInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextDefaultsSize2DInfo Retrieves the state of the parameter MarkerDefaultsSize.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsSize
| public virtual GetMarkerDefaultsSize( | | oValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextDefaultsSize2D Retrieves the MarkerDefaultsSize value.
- Parameters:
-
- oValue
- the marker default size value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsWeightInfo
| public virtual GetMarkerDefaultsWeightInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerDefaultsWeightInfo Retrieves the state of the parameter MarkerDefaultsWeight.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerDefaultsWeight
| public virtual GetMarkerDefaultsWeight( | | oValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerDefaultsWeight Retrieves the MarkerDefaultsWeight value.
- Parameters:
-
- oValue
- the marker default weight value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerTextColorInfo
| public virtual GetMarkerTextColorInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextColor2DInfo Retrieves the state of the parameter MarkerTextColor.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerTextColor
| public virtual GetMarkerTextColor( | | oR, |
| | oG, |
| | oB) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextColor2D Retrieves the MarkerTextColor values.
- Parameters:
-
- oR
- the red value
- oG
- the green value
- oB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerTextDashedInfo
| public virtual GetMarkerTextDashedInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextDashed2DInfo Retrieves the state of the parameter MarkerTextDashed.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerTextDashed
| public virtual GetMarkerTextDashed( | | oValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextDashed2D Retrieves the MarkerTextDashed value.
- Parameters:
-
- oValue
- the marker text dashed value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerTextWeightInfo
| public virtual GetMarkerTextWeightInfo( | | oInfo) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextWeight2DInfo Retrieves the state of the parameter MarkerTextWeight.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetMarkerTextWeight
| public virtual GetMarkerTextWeight( | | oValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.GetMarkerTextWeight2D Retrieves the MarkerTextWeight value.
- Parameters:
-
- oValue
- the marker text weight value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetNumUrlNameInfo
| public virtual GetNumUrlNameInfo( | | oInfo) |
-
Retrieves the state of the parameter NumUrlName.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetNumUrlName
| public virtual GetNumUrlName( | | oMode) |
-
Retrieves the NumUrlName activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPublishAutoLaunchBrowserInfo
| public virtual GetPublishAutoLaunchBrowserInfo( | | oInfo) |
-
Retrieves the state of the parameter PublishAutoLaunchBrowser.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPublishAutoLaunchBrowser
| public virtual GetPublishAutoLaunchBrowser( | | oMode) |
-
Retrieves the PublishAutoLaunchBrowser activation state.
- Parameters:
-
- oMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSceneDefaultsColorInfo
| public virtual GetSceneDefaultsColorInfo( | | oInfo) |
-
Retrieves the state of the parameter SceneDefaultsColor.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSceneDefaultsColor
| public virtual GetSceneDefaultsColor( | | oR, |
| | oG, |
| | oB) |
-
Retrieves the SceneDefaultsColor values.
- Parameters:
-
- oR
- the red value
- oG
- the green value
- oB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClearanceVoxelLock
| public virtual SetClearanceVoxelLock( | | iLock) |
-
Locks or unlocks the ClearanceVoxel parameter.
Role:Locks or unlocks the ClearanceVoxel parameter if it is possible
in the current administrative context. 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 SetClearanceVoxel
| public virtual SetClearanceVoxel( | | iValue) |
-
Set the ClearanceVoxel value.
Role: Set clearence value.
- Parameters:
-
- iValue
- the clearance value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUClashPreviewLock
| public virtual SetDMUClashPreviewLock( | | iLock) |
-
Locks or unlocks the DMUClashPreview parameter.
Role:Locks or unlocks the DMUClashPreview parameter if it is possible
in the current administrative context. 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 SetDMUClashPreview
| public virtual SetDMUClashPreview( | | iMode) |
-
Turns ON/OFF the DMUClashPreview activation.
Role: Activates or desactivates the clash preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUCut3DPreviewLock
| public virtual SetDMUCut3DPreviewLock( | | iLock) |
-
Locks or unlocks the DMUCut3DPreview parameter.
Role:Locks or unlocks the DMUCut3DPreview parameter if it is possible
in the current administrative context. 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 SetDMUCut3DPreview
| public virtual SetDMUCut3DPreview( | | iMode) |
-
Turns ON/OFF the DMUCut3DPreview activation.
Role: Activates or desactivates the 3D cut preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUDistancePreviewLock
| public virtual SetDMUDistancePreviewLock( | | iLock) |
-
Locks or unlocks the DMUDistancePreview parameter.
Role:Locks or unlocks the DMUDistancePreview parameter if it is possible
in the current administrative context. 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 SetDMUDistancePreview
| public virtual SetDMUDistancePreview( | | iMode) |
-
Turns ON/OFF the DMUDistancePreview activation.
Role: Activates or desactivates the distance preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUFreeSpacePreviewLock
| public virtual SetDMUFreeSpacePreviewLock( | | iLock) |
-
Locks or unlocks the DMUFreeSpacePreview parameter.
Role:Locks or unlocks the DMUFreeSpacePreview parameter if it is possible
in the current administrative context. 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 SetDMUFreeSpacePreview
| public virtual SetDMUFreeSpacePreview( | | iMode) |
-
Turns ON/OFF the DMUFreeSpacePreview activation.
Role: Activates or desactivates the free space preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUGroupPreviewHiddenObjectsColorLock
| public virtual SetDMUGroupPreviewHiddenObjectsColorLock( | | iLock) |
-
Locks or unlocks the DMUGroupPreviewHiddenObjectsColor parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsColor parameter if it is possible
in the current administrative context. 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 SetDMUGroupPreviewHiddenObjectsColor
| public virtual SetDMUGroupPreviewHiddenObjectsColor( | | iR, |
| | iG, |
| | iB) |
-
Set the DMUGroupPreviewHiddenObjectsColor values.
Role: Set the color of hidden objects in DMU Group Preview.
- Parameters:
-
- iR
- the red value
- iG
- the green value
- iB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUGroupPreviewHiddenObjectsDisplayModeLock
| public virtual SetDMUGroupPreviewHiddenObjectsDisplayModeLock( | | iLock) |
-
Locks or unlocks the DMUGroupPreviewHiddenObjectsDisplayMode parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsDisplayMode parameter if it is possible
in the current administrative context. 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 SetDMUGroupPreviewHiddenObjectsDisplayMode
| public virtual SetDMUGroupPreviewHiddenObjectsDisplayMode( | | iMode) |
-
Sets the DMUGroupPreviewHiddenObjectsDisplayMode state.
Role: Modifies the display of hidden objects in DMU Group Preview.
- Parameters:
-
- iMode
- Legal values:
0: same display as in main viewer
1: with customized graphic properties
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUGroupPreviewHiddenObjectsLowIntLock
| public virtual SetDMUGroupPreviewHiddenObjectsLowIntLock( | | iLock) |
-
Locks or unlocks the DMUGroupPreviewHiddenObjectsLowInt parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsLowInt parameter if it is possible
in the current administrative context. 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 SetDMUGroupPreviewHiddenObjectsLowInt
| public virtual SetDMUGroupPreviewHiddenObjectsLowInt( | | iMode) |
-
Turns ON/OFF the DMUGroupPreviewHiddenObjectsLowInt activation.
Role: Activates or desactivates the Low Intensity display mode for the hidden objects in DMU Group Preview.
- Parameters:
-
- iMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUGroupPreviewHiddenObjectsOpacityLock
| public virtual SetDMUGroupPreviewHiddenObjectsOpacityLock( | | iLock) |
-
Locks or unlocks the DMUGroupPreviewHiddenObjectsOpacity parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsOpacity parameter if it is possible
in the current administrative context. 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 SetDMUGroupPreviewHiddenObjectsOpacity
| public virtual SetDMUGroupPreviewHiddenObjectsOpacity( | | iOpacity) |
-
Set the DMUGroupPreviewHiddenObjectsoOpacity values.
Role: Set the opacity of hidden objects in DMU Group Preview.
- Parameters:
-
- iOpacity
- the opacity value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUGroupPreviewHiddenObjectsPickLock
| public virtual SetDMUGroupPreviewHiddenObjectsPickLock( | | iLock) |
-
Locks or unlocks the DMUGroupPreviewHiddenObjectsPick parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsPick parameter if it is possible
in the current administrative context. 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 SetDMUGroupPreviewHiddenObjectsPick
| public virtual SetDMUGroupPreviewHiddenObjectsPick( | | iMode) |
-
Turns ON/OFF the DMUGroupPreviewHiddenObjectsPick activation.
Role: Activates or desactivates the pick mode for hidden objects in DMU Group Preview.
- Parameters:
-
- iMode
- Legal values:
0: turned off
1: turned on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUGroupPreviewLock
| public virtual SetDMUGroupPreviewLock( | | iLock) |
-
Locks or unlocks the DMUGroupPreview parameter.
Role:Locks or unlocks the DMUGroupPreview parameter if it is possible
in the current administrative context. 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 SetDMUGroupPreview
| public virtual SetDMUGroupPreview( | | iMode) |
-
Turns ON/OFF the DMUGroupPreview activation.
Role: Activates or desactivates the group preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUMergerPreviewLock
| public virtual SetDMUMergerPreviewLock( | | iLock) |
-
Locks or unlocks the DMUMergerPreview parameter.
Role:Locks or unlocks the DMUMergerPreview parameter if it is possible
in the current administrative context. 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 SetDMUMergerPreview
| public virtual SetDMUMergerPreview( | | iMode) |
-
Turns ON/OFF the DMUMergerPreview activation.
Role: Activates or desactivates the merger preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUOffsetPreviewLock
| public virtual SetDMUOffsetPreviewLock( | | iLock) |
-
Locks or unlocks the DMUOffsetPreview parameter.
Role:Locks or unlocks the DMUOffsetPreview parameter if it is possible
in the current administrative context. 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 SetDMUOffsetPreview
| public virtual SetDMUOffsetPreview( | | iMode) |
-
Turns ON/OFF the DMUOffsetPreview activation.
Role: Activates or desactivates the offset preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUReviewNameLock
| public virtual SetDMUReviewNameLock( | | iLock) |
-
Locks or unlocks the DMUReviewName parameter.
Role:Locks or unlocks the DMUReviewName parameter if it is possible
in the current administrative context. 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 SetDMUReviewName
| public virtual SetDMUReviewName( | | iName) |
-
Set the DMUReviewName value.
Role: Set the DMU Review default name.
- Parameters:
-
- iName
- the DMU Review default name
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUSectionPreviewLock
| public virtual SetDMUSectionPreviewLock( | | iLock) |
-
Locks or unlocks the DMUSectionPreview parameter.
Role:Locks or unlocks the DMUSectionPreview parameter if it is possible
in the current administrative context. 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 SetDMUSectionPreview
| public virtual SetDMUSectionPreview( | | iMode) |
-
Turns ON/OFF the DMUSectionPreview activation.
Role: Activates or desactivates the section preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUShuttlePreviewLock
| public virtual SetDMUShuttlePreviewLock( | | iLock) |
-
Locks or unlocks the DMUShuttlePreview parameter.
Role:Locks or unlocks the DMUShuttlePreview parameter if it is possible
in the current administrative context. 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 SetDMUShuttlePreview
| public virtual SetDMUShuttlePreview( | | iMode) |
-
Turns ON/OFF the DMUShuttlePreview activation.
Role: Activates or desactivates the shutlle preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUSilhouettePreviewLock
| public virtual SetDMUSilhouettePreviewLock( | | iLock) |
-
Locks or unlocks the DMUSilhouettePreview parameter.
Role:Locks or unlocks the DMUSilhouettePreview parameter if it is possible
in the current administrative context. 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 SetDMUSilhouettePreview
| public virtual SetDMUSilhouettePreview( | | iMode) |
-
Turns ON/OFF the DMUSilhouettePreview activation.
Role: Activates or desactivates the silhouette preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUSimplifPreviewLock
| public virtual SetDMUSimplifPreviewLock( | | iLock) |
-
Locks or unlocks the DMUSimplifPreview parameter.
Role:Locks or unlocks the DMUSimplifPreview parameter if it is possible
in the current administrative context. 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 SetDMUSimplifPreview
| public virtual SetDMUSimplifPreview( | | iMode) |
-
Turns ON/OFF the DMUSimplifPreview activation.
Role: Activates or desactivates the mesh simplification preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUSweptVolPreviewLock
| public virtual SetDMUSweptVolPreviewLock( | | iLock) |
-
Locks or unlocks the DMUSweptVolPreview parameter.
Role:Locks or unlocks the DMUSweptVolPreview parameter if it is possible
in the current administrative context. 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 SetDMUSweptVolPreview
| public virtual SetDMUSweptVolPreview( | | iMode) |
-
Turns ON/OFF the DMUSweptVolPreview activation.
Role: Activates or desactivates the swept volume preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUThicknessPreviewLock
| public virtual SetDMUThicknessPreviewLock( | | iLock) |
-
Locks or unlocks the DMUThicknessPreview parameter.
Role:Locks or unlocks the DMUThicknessPreview parameter if it is possible
in the current administrative context. 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 SetDMUThicknessPreview
| public virtual SetDMUThicknessPreview( | | iMode) |
-
Turns ON/OFF the DMUThicknessPreview activation.
Role: Activates or desactivates the thickness preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUVibrationVolPreviewLock
| public virtual SetDMUVibrationVolPreviewLock( | | iLock) |
-
Locks or unlocks the DMUVibrationVolPreview parameter.
Role:Locks or unlocks the DMUVibrationVolPreview parameter if it is possible
in the current administrative context. 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 SetDMUVibrationVolPreview
| public virtual SetDMUVibrationVolPreview( | | iMode) |
-
Turns ON/OFF the DMUVibrationVolPreview activation.
Role: Activates or desactivates the vibration volume preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDMUWrappingPreviewLock
| public virtual SetDMUWrappingPreviewLock( | | iLock) |
-
Locks or unlocks the DMUWrappingPreview parameter.
Role:Locks or unlocks the DMUWrappingPreview parameter if it is possible
in the current administrative context. 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 SetDMUWrappingPreview
| public virtual SetDMUWrappingPreview( | | iMode) |
-
Turns ON/OFF the DMUWrappingPreview activation.
Role: Activates or desactivates the wrapping preview display.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetForceClearanceVoxelLock
| public virtual SetForceClearanceVoxelLock( | | iLock) |
-
Locks or unlocks the ForceClearanceVoxel parameter.
Role:Locks or unlocks the ForceClearanceVoxel parameter if it is possible
in the current administrative context. 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 SetForceClearanceVoxel
| public virtual SetForceClearanceVoxel( | | iMode) |
-
Turns ON/OFF the ForceClearanceVoxel activation.
Role: Activates or desactivates the clearance value in interactive mode.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetForceVoxelLock
| public virtual SetForceVoxelLock( | | iLock) |
-
Locks or unlocks the ForceVoxel parameter.
Role:Locks or unlocks the ForceVoxel parameter if it is possible
in the current administrative context. 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 SetForceVoxel
| public virtual SetForceVoxel( | | iMode) |
-
Turns ON/OFF the ForceVoxel activation.
Role: Activates or desactivates the released accuracy in interactive mode.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetInsertLevelLock
| public virtual SetInsertLevelLock( | | iLock) |
-
Locks or unlocks the InsertLevel parameter.
Role:Locks or unlocks the InsertMode parameter if it is possible
in the current administrative context. 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 SetInsertLevel
| public virtual SetInsertLevel( | | iLevel) |
-
Turns ON/OFF the InsertLevel activation.
Role: tells where the importa applicative data is done.
- Parameters:
-
- iLevel
- Legal values:
0: insert is done in current review
1: insert is done at highest level
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetInsertModeLock
| public virtual SetInsertModeLock( | | iLock) |
-
Locks or unlocks the InsertMode parameter.
Role:Locks or unlocks the InsertMode parameter if it is possible
in the current administrative context. 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 SetInsertMode
| public virtual SetInsertMode( | | iMode) |
-
Turns ON/OFF the InsertMode activation.
Role: Activates or desactivates the import applicative data option.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on with automatic import of applicative data
2: to turn on with user prompt
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarker2DAutoNamingLock
| public virtual SetMarker2DAutoNamingLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarker2DAutoNamingLock Locks or unlocks the Marker2DAutoNaming parameter.
Role:Locks or unlocks the Marker2DAutoNaming parameter if it is possible
in the current administrative context. 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 SetMarker2DAutoNaming
| public virtual SetMarker2DAutoNaming( | | iMode) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarker2DAutoNaming Turns ON/OFF the Marker2DAutoNaming activation.
Role: Activates or desactivates 2D marker part name recognition.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarker3DAutoNamingLock
| public virtual SetMarker3DAutoNamingLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarker3DAutoNamingLock Locks or unlocks the Marker3DAutoNaming parameter.
Role:Locks or unlocks the Marker3DAutoNaming parameter if it is possible
in the current administrative context. 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 SetMarker3DAutoNaming
| public virtual SetMarker3DAutoNaming( | | iMode) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarker3DAutoNaming Turns ON/OFF the Marker3DAutoNaming activation.
Role: Activates or desactivates the 3D marker with graphic message mode.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerAutoUpdateLock
| public virtual SetMarkerAutoUpdateLock( | | iLock) |
-
Locks or unlocks the MarkerAutoUpdate parameter.
Role:Locks or unlocks the MarkerAutoUpdate parameter if it is possible
in the current administrative context. 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 SetMarkerAutoUpdate
| public virtual SetMarkerAutoUpdate( | | iMode) |
-
Turns ON/OFF the MarkerAutoUpdate activation.
Role: Activates or desactivates the update on product structure modifications and scenes activation .
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerDefaultsColorLock
| public virtual SetMarkerDefaultsColorLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerDefaultsColorLock Locks or unlocks the MarkerDefaultsColor parameter.
Role:Locks or unlocks the MarkerAutoUpdate parameter if it is possible
in the current administrative context. 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 SetMarkerDefaultsColor
| public virtual SetMarkerDefaultsColor( | | iR, |
| | iG, |
| | iB) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerDefaultsColor Set the MarkerDefaultsColor values.
Role: Set the default color for a 2d annotation.
- Parameters:
-
- iR
- the red value
- iG
- the green value
- iB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerDefaultsDashedLock
| public virtual SetMarkerDefaultsDashedLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerDefaultsDashedLock Locks or unlocks the MarkerDefaultsDashed parameter.
Role:Locks or unlocks the MarkerDefaultsDashed parameter if it is possible
in the current administrative context. 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 SetMarkerDefaultsDashed
| public virtual SetMarkerDefaultsDashed( | | iValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerDefaultsDashed Set the MarkerDefaultsDashed value.
Role: Set the default marker dashed value.
- Parameters:
-
- iValue
- the marker default dashed value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerDefaultsFontLock
| public virtual SetMarkerDefaultsFontLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextDefaultsFont2DLock Locks or unlocks the MarkerDefaultsFont parameter.
Role:Locks or unlocks the MarkerDefaultsFont parameter if it is possible
in the current administrative context. 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 SetMarkerDefaultsFont
| public virtual SetMarkerDefaultsFont( | | iFont) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextDefaultsFont2D Set the MarkerDefaultsFont value.
Role: Set the default marker font value.
- Parameters:
-
- iFont
- the marker default font value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerDefaultsSizeLock
| public virtual SetMarkerDefaultsSizeLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextDefaultsSize2DLock Locks or unlocks the MarkerDefaultsSize parameter.
Role:Locks or unlocks the MarkerDefaultsSize parameter if it is possible
in the current administrative context. 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 SetMarkerDefaultsSize
| public virtual SetMarkerDefaultsSize( | | iValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextDefaultsSize2D Set the MarkerDefaultsSize value.
Role: Set the default marker size value.
- Parameters:
-
- iValue
- the marker default size value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerDefaultsWeightLock
| public virtual SetMarkerDefaultsWeightLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerDefaultsWeightLock Locks or unlocks the MarkerDefaultsWeight parameter.
Role:Locks or unlocks the MarkerDefaultsWeight parameter if it is possible
in the current administrative context. 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 SetMarkerDefaultsWeight
| public virtual SetMarkerDefaultsWeight( | | iValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerDefaultsWeight Set the MarkerDefaultsWeight value.
Role: Set the default marker weight value.
- Parameters:
-
- iValue
- the marker default weight value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerTextColorLock
| public virtual SetMarkerTextColorLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextColor2DLock Locks or unlocks the MarkerTextColor parameter.
Role:Locks or unlocks the MarkerAutoUpdate parameter if it is possible
in the current administrative context. 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 SetMarkerTextColor
| public virtual SetMarkerTextColor( | | iR, |
| | iG, |
| | iB) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextColor2D Set the MarkerTextColor values.
Role: Set the color for a marker text.
- Parameters:
-
- iR
- the red value
- iG
- the green value
- iB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerTextDashedLock
| public virtual SetMarkerTextDashedLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextDashed2DLock Locks or unlocks the MarkerTextDashed parameter.
Role:Locks or unlocks the MarkerTextDashed parameter if it is possible
in the current administrative context. 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 SetMarkerTextDashed
| public virtual SetMarkerTextDashed( | | iValue) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextDashed2D Set the MarkerTextDashed value.
Role: Set the marker text dashed value.
- Parameters:
-
- iValue
- the marker text dashed value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetMarkerTextWeightLock
| public virtual SetMarkerTextWeightLock( | | iLock) |
-
- Deprecated:
- R17
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextWeight2DLock Locks or unlocks the MarkerTextWeight parameter.
Role:Locks or unlocks the MarkerTextWeight parameter if it is possible
in the current administrative context. 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 SetMarkerTextWeight
| public virtual SetMarkerTextWeight( | | iValue) |
-
- Deprecated:
- R17
Set the MarkerTextWeight value.
This method will be replaced by
CATIDMUMarkerSettingAtt.SetMarkerTextWeight2D
Role: Set the marker text weight value.
- Parameters:
-
- iValue
- the marker text weight value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetNumUrlNameLock
| public virtual SetNumUrlNameLock( | | iLock) |
-
Locks or unlocks the NumUrlName parameter.
Role:Locks or unlocks the NumUrlName parameter if it is possible
in the current administrative context. 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 SetNumUrlName
| public virtual SetNumUrlName( | | iMode) |
-
Turns ON/OFF the NumUrlName activation.
Role: Activates or desactivates the name display for hyperlink representation.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPublishAutoLaunchBrowserLock
| public virtual SetPublishAutoLaunchBrowserLock( | | iLock) |
-
Locks or unlocks the PublishAutoLaunchBrowser parameter.
Role:Locks or unlocks the PublishAutoLaunchBrowser parameter if it is possible
in the current administrative context. 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 SetPublishAutoLaunchBrowser
| public virtual SetPublishAutoLaunchBrowser( | | iMode) |
-
Turns ON/OFF the PublishAutoLaunchBrowser activation.
Role: Activates or desactivates the automatic launching of publish results.
- Parameters:
-
- iMode
- Legal values:
0: to turn off
1: to turn on
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSceneDefaultsColorLock
| public virtual SetSceneDefaultsColorLock( | | iLock) |
-
Locks or unlocks the SceneDefaultsColor parameter.
Role:Locks or unlocks the SceneDefaultsColor parameter if it is possible
in the current administrative context. 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 SetSceneDefaultsColor
| public virtual SetSceneDefaultsColor( | | iR, |
| | iG, |
| | iB) |
-
Set the SceneDefaultsColor values.
Role: Set the scene background color.
- Parameters:
-
- iR
- the red value
- iG
- the green value
- iB
- the blue value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: CATIDMUN4DNavigatorSettingAtt.h
If needed, your Imakefile.mk should include the module: CATNavigatorItf