All Frameworks Class Hierarchy This Framework Previous Next Indexes
NavigatorInterfaces Interface CATIDMUN4DNavigatorSettingAtt
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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
GetClearanceVoxel(float&)
- Retrieves the ClearanceVoxel value.
- o
GetClearanceVoxelInfo(CATSettingInfo*)
- Retrieves the state of the parameter ClearanceVoxel.
- o
GetDMUClashPreview(unsigned char&)
- Retrieves the DMUClashPreview activation state.
- o
GetDMUClashPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUClashPreview.
- o
GetDMUCut3DPreview(unsigned char&)
- Retrieves the DMUCut3DPreview activation state.
- o
GetDMUCut3DPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUCut3DPreview.
- o
GetDMUDistancePreview(unsigned char&)
- Retrieves the DMUDistancePreview activation state.
- o
GetDMUDistancePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUDistancePreview.
- o
GetDMUFreeSpacePreview(unsigned char&)
- Retrieves the DMUFreeSpacePreview activation state.
- o
GetDMUFreeSpacePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUFreeSpacePreview.
- o
GetDMUGroupPreview(unsigned char&)
- Retrieves the DMUGroupPreview activation state.
- o
GetDMUGroupPreviewHiddenObjectsColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the DMUGroupPreviewHiddenObjectsColor values.
- o
GetDMUGroupPreviewHiddenObjectsColorInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsColor.
- o
GetDMUGroupPreviewHiddenObjectsDisplayMode(unsigned int&)
- Retrieves the DMUGroupPreviewHiddenObjectsDisplayMode state.
- o
GetDMUGroupPreviewHiddenObjectsDisplayModeInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsDisplayMode.
- o
GetDMUGroupPreviewHiddenObjectsLowInt(unsigned char&)
- Retrieves the DMUGroupPreviewHiddenObjectsLowInt activation state.
- o
GetDMUGroupPreviewHiddenObjectsLowIntInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsLowInt.
- o
GetDMUGroupPreviewHiddenObjectsOpacity(unsigned int&)
- Retrieves the DMUGroupPreviewHiddenObjectsOpacity value.
- o
GetDMUGroupPreviewHiddenObjectsOpacityInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsOpacity.
- o
GetDMUGroupPreviewHiddenObjectsPick(unsigned char&)
- Retrieves the DMUGroupPreviewHiddenObjectsPick activation state.
- o
GetDMUGroupPreviewHiddenObjectsPickInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreviewHiddenObjectsPick.
- o
GetDMUGroupPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUGroupPreview.
- o
GetDMUMergerPreview(unsigned char&)
- Retrieves the DMUMergerPreview activation state.
- o
GetDMUMergerPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUMergerPreview.
- o
GetDMUOffsetPreview(unsigned char&)
- Retrieves the DMUOffsetPreview activation state.
- o
GetDMUOffsetPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUOffsetPreview.
- o
GetDMUReviewName(CATUnicodeString&)
- Retrieves the DMUReviewName name.
- o
GetDMUReviewNameInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUReviewName.
- o
GetDMUSectionPreview(unsigned char&)
- Retrieves the DMUSectionPreview activation state.
- o
GetDMUSectionPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSectionPreview.
- o
GetDMUShuttlePreview(unsigned char&)
- Retrieves the DMUShuttlePreview activation state.
- o
GetDMUShuttlePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUShuttlePreview.
- o
GetDMUSilhouettePreview(unsigned char&)
- Retrieves the DMUSilhouettePreview activation state.
- o
GetDMUSilhouettePreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSilhouettePreview.
- o
GetDMUSimplifPreview(unsigned char&)
- Retrieves the DMUSimplifPreview activation state.
- o
GetDMUSimplifPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSimplifPreview.
- o
GetDMUSweptVolPreview(unsigned char&)
- Retrieves the DMUSweptVolPreview activation state.
- o
GetDMUSweptVolPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUSweptVolPreview.
- o
GetDMUThicknessPreview(unsigned char&)
- Retrieves the DMUThicknessPreview activation state.
- o
GetDMUThicknessPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUThicknessPreview.
- o
GetDMUVibrationVolPreview(unsigned char&)
- Retrieves the DMUVibrationVolPreview activation state.
- o
GetDMUVibrationVolPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUVibrationVolPreview.
- o
GetDMUWrappingPreview(unsigned char&)
- Retrieves the DMUWrappingPreview activation state.
- o
GetDMUWrappingPreviewInfo(CATSettingInfo*)
- Retrieves the state of the parameter DMUWrappingPreview.
- o
GetForceClearanceVoxel(unsigned char&)
- Retrieves the ForceClearanceVoxel activation state.
- o
GetForceClearanceVoxelInfo(CATSettingInfo*)
- Retrieves the state of the parameter ForceClearanceVoxel.
- o
GetForceVoxel(unsigned char&)
- Retrieves the ForceVoxel activation state.
- o
GetForceVoxelInfo(CATSettingInfo*)
- Retrieves the state of the parameter ForceVoxel.
- o
GetInsertLevel(int&)
- Retrieves the InsertLevel state.
- o
GetInsertLevelInfo(CATSettingInfo*)
- Retrieves the state of the parameter InsertLevel.
- o
GetInsertMode(int&)
- Retrieves the InsertMode state.
- o
GetInsertModeInfo(CATSettingInfo*)
- Retrieves the state of the parameter InsertMode.
- o
GetMarker2DAutoNaming(unsigned char&)
-
- o
GetMarker2DAutoNamingInfo(CATSettingInfo*)
-
- o
GetMarker3DAutoNaming(unsigned char&)
-
- o
GetMarker3DAutoNamingInfo(CATSettingInfo*)
-
- o
GetMarkerAutoUpdate(unsigned char&)
- Retrieves the MarkerAutoUpdate activation state.
- o
GetMarkerAutoUpdateInfo(CATSettingInfo*)
- Retrieves the state of the parameter MarkerAutoUpdate.
- o
GetMarkerDefaultsColor(unsigned int&,unsigned int&,unsigned int&)
-
- o
GetMarkerDefaultsColorInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsDashed(unsigned int&)
-
- o
GetMarkerDefaultsDashedInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsFont(CATUnicodeString&)
-
- o
GetMarkerDefaultsFontInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsSize(float&)
-
- o
GetMarkerDefaultsSizeInfo(CATSettingInfo*)
-
- o
GetMarkerDefaultsWeight(unsigned int&)
-
- o
GetMarkerDefaultsWeightInfo(CATSettingInfo*)
-
- o
GetMarkerTextColor(unsigned int&,unsigned int&,unsigned int&)
-
- o
GetMarkerTextColorInfo(CATSettingInfo*)
-
- o
GetMarkerTextDashed(unsigned int&)
-
- o
GetMarkerTextDashedInfo(CATSettingInfo*)
-
- o
GetMarkerTextWeight(unsigned int&)
-
- o
GetMarkerTextWeightInfo(CATSettingInfo*)
-
- o
GetNumUrlName(unsigned char&)
- Retrieves the NumUrlName activation state.
- o
GetNumUrlNameInfo(CATSettingInfo*)
- Retrieves the state of the parameter NumUrlName.
- o
GetPublishAutoLaunchBrowser(unsigned char&)
- Retrieves the PublishAutoLaunchBrowser activation state.
- o
GetPublishAutoLaunchBrowserInfo(CATSettingInfo*)
- Retrieves the state of the parameter PublishAutoLaunchBrowser.
- o
GetSceneDefaultsColor(unsigned int&,unsigned int&,unsigned int&)
- Retrieves the SceneDefaultsColor values.
- o
GetSceneDefaultsColorInfo(CATSettingInfo*)
- Retrieves the state of the parameter SceneDefaultsColor.
- o
SetClearanceVoxel(float)
- Set the ClearanceVoxel value.
- o
SetClearanceVoxelLock(unsigned char)
- Locks or unlocks the ClearanceVoxel parameter.
- o
SetDMUClashPreview(unsigned char)
- Turns ON/OFF the DMUClashPreview activation.
- o
SetDMUClashPreviewLock(unsigned char)
- Locks or unlocks the DMUClashPreview parameter.
- o
SetDMUCut3DPreview(unsigned char)
- Turns ON/OFF the DMUCut3DPreview activation.
- o
SetDMUCut3DPreviewLock(unsigned char)
- Locks or unlocks the DMUCut3DPreview parameter.
- o
SetDMUDistancePreview(unsigned char)
- Turns ON/OFF the DMUDistancePreview activation.
- o
SetDMUDistancePreviewLock(unsigned char)
- Locks or unlocks the DMUDistancePreview parameter.
- o
SetDMUFreeSpacePreview(unsigned char)
- Turns ON/OFF the DMUFreeSpacePreview activation.
- o
SetDMUFreeSpacePreviewLock(unsigned char)
- Locks or unlocks the DMUFreeSpacePreview parameter.
- o
SetDMUGroupPreview(unsigned char)
- Turns ON/OFF the DMUGroupPreview activation.
- o
SetDMUGroupPreviewHiddenObjectsColor(unsigned int,unsigned int,unsigned int)
- Set the DMUGroupPreviewHiddenObjectsColor values.
- o
SetDMUGroupPreviewHiddenObjectsColorLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsColor parameter.
- o
SetDMUGroupPreviewHiddenObjectsDisplayMode(unsigned int)
- Sets the DMUGroupPreviewHiddenObjectsDisplayMode state.
- o
SetDMUGroupPreviewHiddenObjectsDisplayModeLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsDisplayMode parameter.
- o
SetDMUGroupPreviewHiddenObjectsLowInt(unsigned char)
- Turns ON/OFF the DMUGroupPreviewHiddenObjectsLowInt activation.
- o
SetDMUGroupPreviewHiddenObjectsLowIntLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsLowInt parameter.
- o
SetDMUGroupPreviewHiddenObjectsOpacity(unsigned int)
- Set the DMUGroupPreviewHiddenObjectsoOpacity values.
- o
SetDMUGroupPreviewHiddenObjectsOpacityLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsOpacity parameter.
- o
SetDMUGroupPreviewHiddenObjectsPick(unsigned char)
- Turns ON/OFF the DMUGroupPreviewHiddenObjectsPick activation.
- o
SetDMUGroupPreviewHiddenObjectsPickLock(unsigned char)
- Locks or unlocks the DMUGroupPreviewHiddenObjectsPick parameter.
- o
SetDMUGroupPreviewLock(unsigned char)
- Locks or unlocks the DMUGroupPreview parameter.
- o
SetDMUMergerPreview(unsigned char)
- Turns ON/OFF the DMUMergerPreview activation.
- o
SetDMUMergerPreviewLock(unsigned char)
- Locks or unlocks the DMUMergerPreview parameter.
- o
SetDMUOffsetPreview(unsigned char)
- Turns ON/OFF the DMUOffsetPreview activation.
- o
SetDMUOffsetPreviewLock(unsigned char)
- Locks or unlocks the DMUOffsetPreview parameter.
- o
SetDMUReviewName(CATUnicodeString)
- Set the DMUReviewName value.
- o
SetDMUReviewNameLock(unsigned char)
- Locks or unlocks the DMUReviewName parameter.
- o
SetDMUSectionPreview(unsigned char)
- Turns ON/OFF the DMUSectionPreview activation.
- o
SetDMUSectionPreviewLock(unsigned char)
- Locks or unlocks the DMUSectionPreview parameter.
- o
SetDMUShuttlePreview(unsigned char)
- Turns ON/OFF the DMUShuttlePreview activation.
- o
SetDMUShuttlePreviewLock(unsigned char)
- Locks or unlocks the DMUShuttlePreview parameter.
- o
SetDMUSilhouettePreview(unsigned char)
- Turns ON/OFF the DMUSilhouettePreview activation.
- o
SetDMUSilhouettePreviewLock(unsigned char)
- Locks or unlocks the DMUSilhouettePreview parameter.
- o
SetDMUSimplifPreview(unsigned char)
- Turns ON/OFF the DMUSimplifPreview activation.
- o
SetDMUSimplifPreviewLock(unsigned char)
- Locks or unlocks the DMUSimplifPreview parameter.
- o
SetDMUSweptVolPreview(unsigned char)
- Turns ON/OFF the DMUSweptVolPreview activation.
- o
SetDMUSweptVolPreviewLock(unsigned char)
- Locks or unlocks the DMUSweptVolPreview parameter.
- o
SetDMUThicknessPreview(unsigned char)
- Turns ON/OFF the DMUThicknessPreview activation.
- o
SetDMUThicknessPreviewLock(unsigned char)
- Locks or unlocks the DMUThicknessPreview parameter.
- o
SetDMUVibrationVolPreview(unsigned char)
- Turns ON/OFF the DMUVibrationVolPreview activation.
- o
SetDMUVibrationVolPreviewLock(unsigned char)
- Locks or unlocks the DMUVibrationVolPreview parameter.
- o
SetDMUWrappingPreview(unsigned char)
- Turns ON/OFF the DMUWrappingPreview activation.
- o
SetDMUWrappingPreviewLock(unsigned char)
- Locks or unlocks the DMUWrappingPreview parameter.
- o
SetForceClearanceVoxel(unsigned char)
- Turns ON/OFF the ForceClearanceVoxel activation.
- o
SetForceClearanceVoxelLock(unsigned char)
- Locks or unlocks the ForceClearanceVoxel parameter.
- o
SetForceVoxel(unsigned char)
- Turns ON/OFF the ForceVoxel activation.
- o
SetForceVoxelLock(unsigned char)
- Locks or unlocks the ForceVoxel parameter.
- o
SetInsertLevel(int)
- Turns ON/OFF the InsertLevel activation.
- o
SetInsertLevelLock(unsigned char)
- Locks or unlocks the InsertLevel parameter.
- o
SetInsertMode(int)
- Turns ON/OFF the InsertMode activation.
- o
SetInsertModeLock(unsigned char)
- Locks or unlocks the InsertMode parameter.
- o
SetMarker2DAutoNaming(unsigned char)
-
- o
SetMarker2DAutoNamingLock(unsigned char)
-
- o
SetMarker3DAutoNaming(unsigned char)
-
- o
SetMarker3DAutoNamingLock(unsigned char)
-
- o
SetMarkerAutoUpdate(unsigned char)
- Turns ON/OFF the MarkerAutoUpdate activation.
- o
SetMarkerAutoUpdateLock(unsigned char)
- Locks or unlocks the MarkerAutoUpdate parameter.
- o
SetMarkerDefaultsColor(unsigned int,unsigned int,unsigned int)
-
- o
SetMarkerDefaultsColorLock(unsigned char)
-
- o
SetMarkerDefaultsDashed(unsigned int)
-
- o
SetMarkerDefaultsDashedLock(unsigned char)
-
- o
SetMarkerDefaultsFont(CATUnicodeString)
-
- o
SetMarkerDefaultsFontLock(unsigned char)
-
- o
SetMarkerDefaultsSize(float)
-
- o
SetMarkerDefaultsSizeLock(unsigned char)
-
- o
SetMarkerDefaultsWeight(unsigned int)
-
- o
SetMarkerDefaultsWeightLock(unsigned char)
-
- o
SetMarkerTextColor(unsigned int,unsigned int,unsigned int)
-
- o
SetMarkerTextColorLock(unsigned char)
-
- o
SetMarkerTextDashed(unsigned int)
-
- o
SetMarkerTextDashedLock(unsigned char)
-
- o
SetMarkerTextWeight(unsigned int)
-
- o
SetMarkerTextWeightLock(unsigned char)
-
- o
SetNumUrlName(unsigned char)
- Turns ON/OFF the NumUrlName activation.
- o
SetNumUrlNameLock(unsigned char)
- Locks or unlocks the NumUrlName parameter.
- o
SetPublishAutoLaunchBrowser(unsigned char)
- Turns ON/OFF the PublishAutoLaunchBrowser activation.
- o
SetPublishAutoLaunchBrowserLock(unsigned char)
- Locks or unlocks the PublishAutoLaunchBrowser parameter.
- o
SetSceneDefaultsColor(unsigned int,unsigned int,unsigned int)
- Set the SceneDefaultsColor values.
- o
SetSceneDefaultsColorLock(unsigned char)
- Locks or unlocks the SceneDefaultsColor parameter.
Methods
o GetClearanceVoxel
public virtual HRESULT GetClearanceVoxel( | float& | oValue)=0 |
-
Retrieves the ClearanceVoxel value.
- Parameters:
-
- oValue
- the clearance value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClearanceVoxelInfo
-
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 GetDMUClashPreview
public virtual HRESULT GetDMUClashPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUClashPreviewInfo
-
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 GetDMUCut3DPreview
public virtual HRESULT GetDMUCut3DPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUCut3DPreviewInfo
-
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 GetDMUDistancePreview
public virtual HRESULT GetDMUDistancePreview( | unsigned char& | oMode)=0 |
-
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 GetDMUDistancePreviewInfo
-
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 GetDMUFreeSpacePreview
public virtual HRESULT GetDMUFreeSpacePreview( | unsigned char& | oMode)=0 |
-
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 GetDMUFreeSpacePreviewInfo
-
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 GetDMUGroupPreview
public virtual HRESULT GetDMUGroupPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUGroupPreviewHiddenObjectsColor
public virtual HRESULT GetDMUGroupPreviewHiddenObjectsColor( | unsigned int& | oR, |
| unsigned int& | oG, |
| unsigned int& | oB)=0 |
-
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 GetDMUGroupPreviewHiddenObjectsColorInfo
-
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 GetDMUGroupPreviewHiddenObjectsDisplayMode
public virtual HRESULT GetDMUGroupPreviewHiddenObjectsDisplayMode( | unsigned int& | oMode)=0 |
-
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 GetDMUGroupPreviewHiddenObjectsDisplayModeInfo
-
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 GetDMUGroupPreviewHiddenObjectsLowInt
public virtual HRESULT GetDMUGroupPreviewHiddenObjectsLowInt( | unsigned char& | oMode)=0 |
-
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 GetDMUGroupPreviewHiddenObjectsLowIntInfo
-
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 GetDMUGroupPreviewHiddenObjectsOpacity
public virtual HRESULT GetDMUGroupPreviewHiddenObjectsOpacity( | unsigned int& | oOpacity)=0 |
-
Retrieves the DMUGroupPreviewHiddenObjectsOpacity value.
- Parameters:
-
- oOpacity
- the opacity value
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUGroupPreviewHiddenObjectsOpacityInfo
-
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 GetDMUGroupPreviewHiddenObjectsPick
public virtual HRESULT GetDMUGroupPreviewHiddenObjectsPick( | unsigned char& | oMode)=0 |
-
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 GetDMUGroupPreviewHiddenObjectsPickInfo
-
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 GetDMUGroupPreviewInfo
-
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 GetDMUMergerPreview
public virtual HRESULT GetDMUMergerPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUMergerPreviewInfo
-
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 GetDMUOffsetPreview
public virtual HRESULT GetDMUOffsetPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUOffsetPreviewInfo
-
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 GetDMUReviewName
-
Retrieves the DMUReviewName name.
- Parameters:
-
- oName
- the DMU Review name
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDMUReviewNameInfo
-
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 GetDMUSectionPreview
public virtual HRESULT GetDMUSectionPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUSectionPreviewInfo
-
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 GetDMUShuttlePreview
public virtual HRESULT GetDMUShuttlePreview( | unsigned char& | oMode)=0 |
-
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 GetDMUShuttlePreviewInfo
-
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 GetDMUSilhouettePreview
public virtual HRESULT GetDMUSilhouettePreview( | unsigned char& | oMode)=0 |
-
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 GetDMUSilhouettePreviewInfo
-
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 GetDMUSimplifPreview
public virtual HRESULT GetDMUSimplifPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUSimplifPreviewInfo
-
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 GetDMUSweptVolPreview
public virtual HRESULT GetDMUSweptVolPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUSweptVolPreviewInfo
-
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 GetDMUThicknessPreview
public virtual HRESULT GetDMUThicknessPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUThicknessPreviewInfo
-
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 GetDMUVibrationVolPreview
public virtual HRESULT GetDMUVibrationVolPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUVibrationVolPreviewInfo
-
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 GetDMUWrappingPreview
public virtual HRESULT GetDMUWrappingPreview( | unsigned char& | oMode)=0 |
-
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 GetDMUWrappingPreviewInfo
-
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 GetForceClearanceVoxel
public virtual HRESULT GetForceClearanceVoxel( | unsigned char& | oMode)=0 |
-
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 GetForceClearanceVoxelInfo
-
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 GetForceVoxel
public virtual HRESULT GetForceVoxel( | unsigned char& | oMode)=0 |
-
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 GetForceVoxelInfo
-
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 GetInsertLevel
public virtual HRESULT GetInsertLevel( | int& | oLevel)=0 |
-
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 GetInsertLevelInfo
-
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 GetInsertMode
public virtual HRESULT GetInsertMode( | int& | oMode)=0 |
-
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 GetInsertModeInfo
-
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 GetMarker2DAutoNaming
public virtual HRESULT GetMarker2DAutoNaming( | unsigned char& | oMode)=0 |
-
- 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 GetMarker2DAutoNamingInfo
-
- 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 GetMarker3DAutoNaming
public virtual HRESULT GetMarker3DAutoNaming( | unsigned char& | oMode)=0 |
-
- 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 GetMarker3DAutoNamingInfo
-
- 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 GetMarkerAutoUpdate
public virtual HRESULT GetMarkerAutoUpdate( | unsigned char& | oMode)=0 |
-
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 GetMarkerAutoUpdateInfo
-
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 GetMarkerDefaultsColor
public virtual HRESULT GetMarkerDefaultsColor( | unsigned int& | oR, |
| unsigned int& | oG, |
| unsigned int& | oB)=0 |
-
- 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 GetMarkerDefaultsColorInfo
-
- 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 GetMarkerDefaultsDashed
public virtual HRESULT GetMarkerDefaultsDashed( | unsigned int& | oValue)=0 |
-
- 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 GetMarkerDefaultsDashedInfo
-
- 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 GetMarkerDefaultsFont
-
- 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 GetMarkerDefaultsFontInfo
-
- 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 GetMarkerDefaultsSize
public virtual HRESULT GetMarkerDefaultsSize( | float& | oValue)=0 |
-
- 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 GetMarkerDefaultsSizeInfo
-
- 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 GetMarkerDefaultsWeight
public virtual HRESULT GetMarkerDefaultsWeight( | unsigned int& | oValue)=0 |
-
- 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 GetMarkerDefaultsWeightInfo
-
- 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 GetMarkerTextColor
public virtual HRESULT GetMarkerTextColor( | unsigned int& | oR, |
| unsigned int& | oG, |
| unsigned int& | oB)=0 |
-
- 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 GetMarkerTextColorInfo
-
- 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 GetMarkerTextDashed
public virtual HRESULT GetMarkerTextDashed( | unsigned int& | oValue)=0 |
-
- 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 GetMarkerTextDashedInfo
-
- 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 GetMarkerTextWeight
public virtual HRESULT GetMarkerTextWeight( | unsigned int& | oValue)=0 |
-
- 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 GetMarkerTextWeightInfo
-
- 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 GetNumUrlName
public virtual HRESULT GetNumUrlName( | unsigned char& | oMode)=0 |
-
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 GetNumUrlNameInfo
-
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 GetPublishAutoLaunchBrowser
public virtual HRESULT GetPublishAutoLaunchBrowser( | unsigned char& | oMode)=0 |
-
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 GetPublishAutoLaunchBrowserInfo
-
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 GetSceneDefaultsColor
public virtual HRESULT GetSceneDefaultsColor( | unsigned int& | oR, |
| unsigned int& | oG, |
| unsigned int& | oB)=0 |
-
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 GetSceneDefaultsColorInfo
-
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 SetClearanceVoxel
public virtual HRESULT SetClearanceVoxel( | float | iValue)=0 |
-
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 SetClearanceVoxelLock
public virtual HRESULT SetClearanceVoxelLock( | unsigned char | iLock)=0 |
-
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 SetDMUClashPreview
public virtual HRESULT SetDMUClashPreview( | unsigned char | iMode)=0 |
-
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 SetDMUClashPreviewLock
public virtual HRESULT SetDMUClashPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUCut3DPreview
public virtual HRESULT SetDMUCut3DPreview( | unsigned char | iMode)=0 |
-
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 SetDMUCut3DPreviewLock
public virtual HRESULT SetDMUCut3DPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUDistancePreview
public virtual HRESULT SetDMUDistancePreview( | unsigned char | iMode)=0 |
-
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 SetDMUDistancePreviewLock
public virtual HRESULT SetDMUDistancePreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUFreeSpacePreview
public virtual HRESULT SetDMUFreeSpacePreview( | unsigned char | iMode)=0 |
-
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 SetDMUFreeSpacePreviewLock
public virtual HRESULT SetDMUFreeSpacePreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUGroupPreview
public virtual HRESULT SetDMUGroupPreview( | unsigned char | iMode)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsColor
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsColor( | unsigned int | iR, |
| unsigned int | iG, |
| unsigned int | iB)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsColorLock
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsColorLock( | unsigned char | iLock)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsDisplayMode
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsDisplayMode( | unsigned int | iMode)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsDisplayModeLock
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsDisplayModeLock( | unsigned char | iLock)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsLowInt
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsLowInt( | unsigned char | iMode)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsLowIntLock
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsLowIntLock( | unsigned char | iLock)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsOpacity
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsOpacity( | unsigned int | iOpacity)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsOpacityLock
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsOpacityLock( | unsigned char | iLock)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsPick
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsPick( | unsigned char | iMode)=0 |
-
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 SetDMUGroupPreviewHiddenObjectsPickLock
public virtual HRESULT SetDMUGroupPreviewHiddenObjectsPickLock( | unsigned char | iLock)=0 |
-
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 SetDMUGroupPreviewLock
public virtual HRESULT SetDMUGroupPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUMergerPreview
public virtual HRESULT SetDMUMergerPreview( | unsigned char | iMode)=0 |
-
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 SetDMUMergerPreviewLock
public virtual HRESULT SetDMUMergerPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUOffsetPreview
public virtual HRESULT SetDMUOffsetPreview( | unsigned char | iMode)=0 |
-
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 SetDMUOffsetPreviewLock
public virtual HRESULT SetDMUOffsetPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUReviewName
-
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 SetDMUReviewNameLock
public virtual HRESULT SetDMUReviewNameLock( | unsigned char | iLock)=0 |
-
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 SetDMUSectionPreview
public virtual HRESULT SetDMUSectionPreview( | unsigned char | iMode)=0 |
-
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 SetDMUSectionPreviewLock
public virtual HRESULT SetDMUSectionPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUShuttlePreview
public virtual HRESULT SetDMUShuttlePreview( | unsigned char | iMode)=0 |
-
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 SetDMUShuttlePreviewLock
public virtual HRESULT SetDMUShuttlePreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUSilhouettePreview
public virtual HRESULT SetDMUSilhouettePreview( | unsigned char | iMode)=0 |
-
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 SetDMUSilhouettePreviewLock
public virtual HRESULT SetDMUSilhouettePreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUSimplifPreview
public virtual HRESULT SetDMUSimplifPreview( | unsigned char | iMode)=0 |
-
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 SetDMUSimplifPreviewLock
public virtual HRESULT SetDMUSimplifPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUSweptVolPreview
public virtual HRESULT SetDMUSweptVolPreview( | unsigned char | iMode)=0 |
-
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 SetDMUSweptVolPreviewLock
public virtual HRESULT SetDMUSweptVolPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUThicknessPreview
public virtual HRESULT SetDMUThicknessPreview( | unsigned char | iMode)=0 |
-
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 SetDMUThicknessPreviewLock
public virtual HRESULT SetDMUThicknessPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUVibrationVolPreview
public virtual HRESULT SetDMUVibrationVolPreview( | unsigned char | iMode)=0 |
-
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 SetDMUVibrationVolPreviewLock
public virtual HRESULT SetDMUVibrationVolPreviewLock( | unsigned char | iLock)=0 |
-
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 SetDMUWrappingPreview
public virtual HRESULT SetDMUWrappingPreview( | unsigned char | iMode)=0 |
-
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 SetDMUWrappingPreviewLock
public virtual HRESULT SetDMUWrappingPreviewLock( | unsigned char | iLock)=0 |
-
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 SetForceClearanceVoxel
public virtual HRESULT SetForceClearanceVoxel( | unsigned char | iMode)=0 |
-
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 SetForceClearanceVoxelLock
public virtual HRESULT SetForceClearanceVoxelLock( | unsigned char | iLock)=0 |
-
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 SetForceVoxel
public virtual HRESULT SetForceVoxel( | unsigned char | iMode)=0 |
-
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 SetForceVoxelLock
public virtual HRESULT SetForceVoxelLock( | unsigned char | iLock)=0 |
-
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 SetInsertLevel
public virtual HRESULT SetInsertLevel( | int | iLevel)=0 |
-
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 SetInsertLevelLock
public virtual HRESULT SetInsertLevelLock( | unsigned char | iLock)=0 |
-
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 SetInsertMode
public virtual HRESULT SetInsertMode( | int | iMode)=0 |
-
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 SetInsertModeLock
public virtual HRESULT SetInsertModeLock( | unsigned char | iLock)=0 |
-
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 SetMarker2DAutoNaming
public virtual HRESULT SetMarker2DAutoNaming( | unsigned char | iMode)=0 |
-
- 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 SetMarker2DAutoNamingLock
public virtual HRESULT SetMarker2DAutoNamingLock( | unsigned char | iLock)=0 |
-
- 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 SetMarker3DAutoNaming
public virtual HRESULT SetMarker3DAutoNaming( | unsigned char | iMode)=0 |
-
- 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 SetMarker3DAutoNamingLock
public virtual HRESULT SetMarker3DAutoNamingLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerAutoUpdate
public virtual HRESULT SetMarkerAutoUpdate( | unsigned char | iMode)=0 |
-
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 SetMarkerAutoUpdateLock
public virtual HRESULT SetMarkerAutoUpdateLock( | unsigned char | iLock)=0 |
-
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 SetMarkerDefaultsColor
public virtual HRESULT SetMarkerDefaultsColor( | unsigned int | iR, |
| unsigned int | iG, |
| unsigned int | iB)=0 |
-
- 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 SetMarkerDefaultsColorLock
public virtual HRESULT SetMarkerDefaultsColorLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerDefaultsDashed
public virtual HRESULT SetMarkerDefaultsDashed( | unsigned int | iValue)=0 |
-
- 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 SetMarkerDefaultsDashedLock
public virtual HRESULT SetMarkerDefaultsDashedLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerDefaultsFont
-
- 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 SetMarkerDefaultsFontLock
public virtual HRESULT SetMarkerDefaultsFontLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerDefaultsSize
public virtual HRESULT SetMarkerDefaultsSize( | float | iValue)=0 |
-
- 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 SetMarkerDefaultsSizeLock
public virtual HRESULT SetMarkerDefaultsSizeLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerDefaultsWeight
public virtual HRESULT SetMarkerDefaultsWeight( | unsigned int | iValue)=0 |
-
- 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 SetMarkerDefaultsWeightLock
public virtual HRESULT SetMarkerDefaultsWeightLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerTextColor
public virtual HRESULT SetMarkerTextColor( | unsigned int | iR, |
| unsigned int | iG, |
| unsigned int | iB)=0 |
-
- 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 SetMarkerTextColorLock
public virtual HRESULT SetMarkerTextColorLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerTextDashed
public virtual HRESULT SetMarkerTextDashed( | unsigned int | iValue)=0 |
-
- 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 SetMarkerTextDashedLock
public virtual HRESULT SetMarkerTextDashedLock( | unsigned char | iLock)=0 |
-
- 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 SetMarkerTextWeight
public virtual HRESULT SetMarkerTextWeight( | unsigned int | iValue)=0 |
-
- 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 SetMarkerTextWeightLock
public virtual HRESULT SetMarkerTextWeightLock( | unsigned char | iLock)=0 |
-
- 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 SetNumUrlName
public virtual HRESULT SetNumUrlName( | unsigned char | iMode)=0 |
-
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 SetNumUrlNameLock
public virtual HRESULT SetNumUrlNameLock( | unsigned char | iLock)=0 |
-
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 SetPublishAutoLaunchBrowser
public virtual HRESULT SetPublishAutoLaunchBrowser( | unsigned char | iMode)=0 |
-
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 SetPublishAutoLaunchBrowserLock
public virtual HRESULT SetPublishAutoLaunchBrowserLock( | unsigned char | iLock)=0 |
-
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 SetSceneDefaultsColor
public virtual HRESULT SetSceneDefaultsColor( | unsigned int | iR, |
| unsigned int | iG, |
| unsigned int | iB)=0 |
-
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
o SetSceneDefaultsColorLock
public virtual HRESULT SetSceneDefaultsColorLock( | unsigned char | iLock)=0 |
-
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
This object is included in the file: CATIDMUN4DNavigatorSettingAtt.h
If needed, your Imakefile.mk should include the module: CATNavigatorItf