All Frameworks Class Hierarchy This Framework Indexes
SpaceAnalysisInterfaces Interface CATISPASectioningSettingAtt
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISPASectioningSettingAtt
Definition of all parameters in Sectioning functionality.
Method Index
- o
GetClippingModeInfo(CATSettingInfo*)
- Retrieves the state of the ClippingMode parameter.
- o
GetClippingMode(CatSectionClippingMode*)
- Retrieves the ClippingMode attribute.
- o
GetDisplayCutInWireframeInfo(CATSettingInfo*)
- Retrieves the state of the DisplayCutInWireframe parameter.
- o
GetDisplayCutInWireframe(int*)
- Retrieves the DisplayCutInWireframe attribute.
- o
GetGridAutoFilteringInfo(CATSettingInfo*)
- Retrieves the state of the GridAutoFiltering parameter.
- o
GetGridAutoFiltering(int*)
- Retrieves the GridAutoFiltering attribute.
- o
GetGridAutoResizeInfo(CATSettingInfo*)
- Retrieves the state of the GridAutoResize parameter.
- o
GetGridAutoResize(int*)
- Retrieves the GridAutoResize attribute.
- o
GetGridHeightStepInfo(CATSettingInfo*)
- Retrieves the state of the GridHeightStep parameter.
- o
GetGridHeightStep(float*)
- Retrieves the GridHeightStep attribute.
- o
GetGridPositionModeInfo(CATSettingInfo*)
- Retrieves the state of the GridPositionMode parameter.
- o
GetGridPositionMode(CatGridPositionMode*)
- Retrieves the GridPositionMode attribute.
- o
GetGridStyleInfo(CATSettingInfo*)
- Retrieves the state of the GridStyle parameter.
- o
GetGridStyle(CatSectionGridStyle*)
- Retrieves the GridStyle attribute.
- o
GetGridWidthStepInfo(CATSettingInfo*)
- Retrieves the state of the GridWidthStep parameter.
- o
GetGridWidthStep(float*)
- Retrieves the GridWidthStep attribute.
- o
GetHidePlaneInfo(CATSettingInfo*)
- Retrieves the state of the HidePlane parameter.
- o
GetHidePlane(int*)
- Retrieves the HidePlane attribute.
- o
GetHideResultInfo(CATSettingInfo*)
- Retrieves the state of the HideResult parameter.
- o
GetHideResult(int*)
- Retrieves the HideResult attribute.
- o
GetPlaneColorInfo(CATSettingInfo*)
- Retrieves the state of the PlaneColor parameter.
- o
GetPlaneColor(unsigned int*)
- Retrieves the PlaneColor attribute.
- o
GetPlaneNormalInfo(CATSettingInfo*)
- Retrieves the state of the PlaneNormal parameter.
- o
GetPlaneNormal(CatSectionPlaneNormal*)
- Retrieves the PlaneNormal attribute.
- o
GetPlaneOriginInfo(CATSettingInfo*)
- Retrieves the state of the PlaneOrigin parameter.
- o
GetPlaneOrigin(CatSectionPlaneOrigin*)
- Retrieves the PlaneOrigin attribute.
- o
GetSectionFillInfo(CATSettingInfo*)
- Retrieves the state of the SectionFill parameter.
- o
GetSectionFill(int*)
- Retrieves the SectionFill attribute.
- o
GetUpdateResultInfo(CATSettingInfo*)
- Retrieves the state of the UpdateResult parameter.
- o
GetUpdateResult(int*)
- Retrieves the UpdateResult attribute.
- o
GetViewerAutoOpenInfo(CATSettingInfo*)
- Retrieves the state of the ViewerAutoOpen parameter.
- o
GetViewerAutoOpen(int*)
- Retrieves the ViewerAutoOpen attribute.
- o
GetViewerAutoReframeInfo(CATSettingInfo*)
- Retrieves the state of the ViewerAutoReframe parameter.
- o
GetViewerAutoReframe(int*)
- Retrieves the ViewerAutoReframe attribute.
- o
GetViewerLock2DInfo(CATSettingInfo*)
- Retrieves the state of the ViewerLock2D parameter.
- o
GetViewerLock2D(int*)
- Retrieves the ViewerLock2D attribute.
- o
GetWindowDefaultHeightInfo(CATSettingInfo*)
- Retrieves the state of the WindowDefaultHeight parameter.
- o
GetWindowDefaultHeight(int&)
-
Role:Retrieve section window default height if the
window open mode is catSecWindow_DefaultSize
- o
GetWindowDefaultWidthInfo(CATSettingInfo*)
- Retrieves the state of the WindowDefaultWidth parameter.
- o
GetWindowDefaultWidth(int&)
-
Role:Retrieve section window default width if the
window open mode is catSecWindow_DefaultSize
- o
GetWindowOpenModeInfo(CATSettingInfo*)
- Retrieves the state of the WindowOpenMode parameter.
- o
GetWindowOpenMode(CatSecWindowOpenMode&)
-
Role: Get section window open mode
- o
SetClippingModeLock(unsigned char)
- Locks or unlocks the ClippingMode parameter.
- o
SetClippingMode(CatSectionClippingMode*)
- Sets the ClippingMode attribute.
- o
SetDisplayCutInWireframeLock(unsigned char)
- Locks or unlocks the DisplayCutInWireframe parameter.
- o
SetDisplayCutInWireframe(int*)
- Sets the DisplayCutInWireframe attribute.
- o
SetGridAutoFilteringLock(unsigned char)
- Locks or unlocks the GridAutoFiltering parameter.
- o
SetGridAutoFiltering(int*)
- Sets the GridAutoFiltering attribute.
- o
SetGridAutoResizeLock(unsigned char)
- Locks or unlocks the GridAutoResize parameter.
- o
SetGridAutoResize(int*)
- Sets the GridAutoResize attribute.
- o
SetGridHeightStepLock(unsigned char)
- Locks or unlocks the GridHeightStep parameter.
- o
SetGridHeightStep(float*)
- Sets the GridHeightStep attribute.
- o
SetGridPositionModeLock(unsigned char)
- Locks or unlocks the GridPositionMode parameter.
- o
SetGridPositionMode(CatGridPositionMode*)
- Sets the GridPositionMode attribute.
- o
SetGridStyleLock(unsigned char)
- Locks or unlocks the GridStyle parameter.
- o
SetGridStyle(CatSectionGridStyle*)
- Sets the GridStyle attribute.
- o
SetGridWidthStepLock(unsigned char)
- Locks or unlocks the GridWidthStep parameter.
- o
SetGridWidthStep(float*)
- Sets the GridWidthStep attribute.
- o
SetHidePlaneLock(unsigned char)
- Locks or unlocks the HidePlane parameter.
- o
SetHidePlane(int*)
- Sets the PlaneAutoHide attribute.
- o
SetHideResultLock(unsigned char)
- Locks or unlocks the HideResult parameter.
- o
SetHideResult(int*)
- Sets the HideResult attribute.
- o
SetPlaneColorLock(unsigned char)
- Locks or unlocks the PlaneColor parameter.
- o
SetPlaneColor(unsigned int*)
- Sets the PlaneColor attribute.
- o
SetPlaneNormalLock(unsigned char)
- Locks or unlocks the PlaneNormal parameter.
- o
SetPlaneNormal(CatSectionPlaneNormal*)
- Sets the PlaneNormal attribute.
- o
SetPlaneOriginLock(unsigned char)
- Locks or unlocks the PlaneOrigin parameter.
- o
SetPlaneOrigin(CatSectionPlaneOrigin*)
- Sets the PlaneOrigin attribute.
- o
SetSectionFillLock(unsigned char)
- Locks or unlocks the SectionFill parameter.
- o
SetSectionFill(int*)
- Sets the SectionFill attribute.
- o
SetUpdateResultLock(unsigned char)
- Locks or unlocks the UpdateResult parameter.
- o
SetUpdateResult(int*)
- Sets the UpdateResult attribute.
- o
SetViewerAutoOpenLock(unsigned char)
- Locks or unlocks the ViewerAutoOpen parameter.
- o
SetViewerAutoOpen(int*)
- Sets the ViewerAutoOpen attribute.
- o
SetViewerAutoReframeLock(unsigned char)
- Locks or unlocks the ViewerAutoReframe parameter.
- o
SetViewerAutoReframe(int*)
- Sets the ViewerAutoReframe attribute.
- o
SetViewerLock2DLock(unsigned char)
- Locks or unlocks the ViewerLock2D parameter.
- o
SetViewerLock2D(int*)
- Sets the ViewerLock2D attribute.
- o
SetWindowDefaultHeightLock(unsigned char)
- Locks or unlocks the WindowDefaultHeight parameter.
- o
SetWindowDefaultHeight(int)
-
Role:Set the section window default height if the
window open mode is catSecWindow_DefaultSize
- o
SetWindowDefaultWidthLock(unsigned char)
- Locks or unlocks the WindowDefaultWidth parameter.
- o
SetWindowDefaultWidth(int)
-
Role:Set the section window default width if the
window open mode is catSecWindow_DefaultSize
- o
SetWindowOpenModeLock(unsigned char)
- Locks or unlocks the WindowOpenMode parameter.
- o
SetWindowOpenMode(CatSecWindowOpenMode)
-
Role:Set the section window open mode
Methods
o GetClippingModeInfo
| public virtual GetClippingModeInfo( | | oInfo) |
-
Retrieves the state of the ClippingMode parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClippingMode
| public virtual GetClippingMode( | | oClippingMode) |
-
Retrieves the ClippingMode attribute.
o GetDisplayCutInWireframeInfo
| public virtual GetDisplayCutInWireframeInfo( | | oInfo) |
-
Retrieves the state of the DisplayCutInWireframe parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayCutInWireframe
| public virtual GetDisplayCutInWireframe( | | oDisplayCutInWireframe) |
-
Retrieves the DisplayCutInWireframe attribute.
o GetGridAutoFilteringInfo
| public virtual GetGridAutoFilteringInfo( | | oInfo) |
-
Retrieves the state of the GridAutoFiltering parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridAutoFiltering
| public virtual GetGridAutoFiltering( | | oGridAutoFiltering) |
-
Retrieves the GridAutoFiltering attribute.
o GetGridAutoResizeInfo
| public virtual GetGridAutoResizeInfo( | | oInfo) |
-
Retrieves the state of the GridAutoResize parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridAutoResize
| public virtual GetGridAutoResize( | | oGridAutoResize) |
-
Retrieves the GridAutoResize attribute.
o GetGridHeightStepInfo
| public virtual GetGridHeightStepInfo( | | oInfo) |
-
Retrieves the state of the GridHeightStep parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridHeightStep
| public virtual GetGridHeightStep( | | oGridHeightStep) |
-
Retrieves the GridHeightStep attribute.
- Parameters:
-
- oGridHeightStep
- The interval between two horizontal lines of the grid, expressed
in the storage unit of the length magnitude.
(see
CATICkeMagnitude for details).
o GetGridPositionModeInfo
| public virtual GetGridPositionModeInfo( | | oInfo) |
-
Retrieves the state of the GridPositionMode parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridPositionMode
| public virtual GetGridPositionMode( | | oGridPositionMode) |
-
Retrieves the GridPositionMode attribute.
o GetGridStyleInfo
| public virtual GetGridStyleInfo( | | oInfo) |
-
Retrieves the state of the GridStyle parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridStyle
| public virtual GetGridStyle( | | oGridStyle) |
-
Retrieves the GridStyle attribute.
o GetGridWidthStepInfo
| public virtual GetGridWidthStepInfo( | | oInfo) |
-
Retrieves the state of the GridWidthStep parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetGridWidthStep
| public virtual GetGridWidthStep( | | oGridWidthStep) |
-
Retrieves the GridWidthStep attribute.
- Parameters:
-
- oGridWidthStep
- The interval between two vertical lines of the grid, expressed
in the storage unit of the length magnitude.
(see
CATICkeMagnitude for details).
o GetHidePlaneInfo
| public virtual GetHidePlaneInfo( | | oInfo) |
-
Retrieves the state of the HidePlane parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetHidePlane
| public virtual GetHidePlane( | | oHidePlane) |
-
Retrieves the HidePlane attribute.
o GetHideResultInfo
| public virtual GetHideResultInfo( | | oInfo) |
-
Retrieves the state of the HideResult parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetHideResult
| public virtual GetHideResult( | | oHideResult) |
-
Retrieves the HideResult attribute.
o GetPlaneColorInfo
| public virtual GetPlaneColorInfo( | | oInfo) |
-
Retrieves the state of the PlaneColor parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPlaneColor
| public virtual GetPlaneColor( | | oPlaneColor) |
-
Retrieves the PlaneColor attribute.
- Parameters:
-
- ioPlaneColor:
- Legal values:
Array of 3 unsigned int (R,G,B).
o GetPlaneNormalInfo
| public virtual GetPlaneNormalInfo( | | oInfo) |
-
Retrieves the state of the PlaneNormal parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPlaneNormal
| public virtual GetPlaneNormal( | | oPlaneNormal) |
-
Retrieves the PlaneNormal attribute.
o GetPlaneOriginInfo
| public virtual GetPlaneOriginInfo( | | oInfo) |
-
Retrieves the state of the PlaneOrigin parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPlaneOrigin
| public virtual GetPlaneOrigin( | | oPlaneOrigin) |
-
Retrieves the PlaneOrigin attribute.
o GetSectionFillInfo
| public virtual GetSectionFillInfo( | | oInfo) |
-
Retrieves the state of the SectionFill parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetSectionFill
| public virtual GetSectionFill( | | oSectionFill) |
-
Retrieves the SectionFill attribute.
o GetUpdateResultInfo
| public virtual GetUpdateResultInfo( | | oInfo) |
-
Retrieves the state of the UpdateResult parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetUpdateResult
| public virtual GetUpdateResult( | | oUpdateResult) |
-
Retrieves the UpdateResult attribute.
o GetViewerAutoOpenInfo
| public virtual GetViewerAutoOpenInfo( | | oInfo) |
-
Retrieves the state of the ViewerAutoOpen parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewerAutoOpen
| public virtual GetViewerAutoOpen( | | oViewerAutoOpen) |
-
Retrieves the ViewerAutoOpen attribute.
o GetViewerAutoReframeInfo
| public virtual GetViewerAutoReframeInfo( | | oInfo) |
-
Retrieves the state of the ViewerAutoReframe parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewerAutoReframe
| public virtual GetViewerAutoReframe( | | oViewerAutoReframe) |
-
Retrieves the ViewerAutoReframe attribute.
o GetViewerLock2DInfo
| public virtual GetViewerLock2DInfo( | | oInfo) |
-
Retrieves the state of the ViewerLock2D parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewerLock2D
| public virtual GetViewerLock2D( | | oViewerLock2D) |
-
Retrieves the ViewerLock2D attribute.
o GetWindowDefaultHeightInfo
| public virtual GetWindowDefaultHeightInfo( | | oInfo) |
-
Retrieves the state of the WindowDefaultHeight parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetWindowDefaultHeight
| public virtual GetWindowDefaultHeight( | | oWindowDefaultHeight) |
-
Role:Retrieve section window default height if the
window open mode is catSecWindow_DefaultSize
- Parameters:
-
- oWindowDefaultHeight
-
- Returns:
- S_OK Successfully retieved the window open mode
E_FAIL Failed to retrieved the window open mode
o GetWindowDefaultWidthInfo
| public virtual GetWindowDefaultWidthInfo( | | oInfo) |
-
Retrieves the state of the WindowDefaultWidth parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetWindowDefaultWidth
| public virtual GetWindowDefaultWidth( | | oWindowDefaultWidth) |
-
Role:Retrieve section window default width if the
window open mode is catSecWindow_DefaultSize
- Parameters:
-
- oWindowDefaultWidth
-
- Returns:
- S_OK Successfully retieved the window open mode
E_FAIL Failed to retrieved the window open mode
o GetWindowOpenModeInfo
| public virtual GetWindowOpenModeInfo( | | oInfo) |
-
Retrieves the state of the WindowOpenMode parameter.
- Parameters:
-
- oInfo
- Address of an object CATSettingInfo.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o GetWindowOpenMode
| public virtual GetWindowOpenMode( | | oWindowOpenMode) |
-
Role: Get section window open mode
- Parameters:
-
- oWindowOpenMode
- Legal values:
catSecWindow_DefaultSize :Opens the sectioning window(s) with the default size specified in the Tools->Options.
catSecWindow_TileVertically :Tiles the sectioning window(s) vertically in the viewer
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingModeLock
| public virtual SetClippingModeLock( | | iLocked) |
-
Locks or unlocks the ClippingMode parameter.
Role: Locks or unlocks the ClippingMode parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingMode
| public virtual SetClippingMode( | | iClippingMode) |
-
Sets the ClippingMode attribute.
o SetDisplayCutInWireframeLock
| public virtual SetDisplayCutInWireframeLock( | | iLocked) |
-
Locks or unlocks the DisplayCutInWireframe parameter.
Role: Locks or unlocks the DisplayCutInWireframe parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDisplayCutInWireframe
| public virtual SetDisplayCutInWireframe( | | iDisplayCutInWireframe) |
-
Sets the DisplayCutInWireframe attribute.
o SetGridAutoFilteringLock
| public virtual SetGridAutoFilteringLock( | | iLocked) |
-
Locks or unlocks the GridAutoFiltering parameter.
Role: Locks or unlocks the GridAutoFiltering parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridAutoFiltering
| public virtual SetGridAutoFiltering( | | iGridAutoFiltering) |
-
Sets the GridAutoFiltering attribute.
o SetGridAutoResizeLock
| public virtual SetGridAutoResizeLock( | | iLocked) |
-
Locks or unlocks the GridAutoResize parameter.
Role: Locks or unlocks the GridAutoResize parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridAutoResize
| public virtual SetGridAutoResize( | | iGridAutoResize) |
-
Sets the GridAutoResize attribute.
o SetGridHeightStepLock
| public virtual SetGridHeightStepLock( | | iLocked) |
-
Locks or unlocks the GridHeightStep parameter.
Role: Locks or unlocks the GridHeightStep parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridHeightStep
| public virtual SetGridHeightStep( | | iGridHeightStep) |
-
Sets the GridHeightStep attribute.
o SetGridPositionModeLock
| public virtual SetGridPositionModeLock( | | iLocked) |
-
Locks or unlocks the GridPositionMode parameter.
Role: Locks or unlocks the GridPositionMode parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridPositionMode
| public virtual SetGridPositionMode( | | iGridPositionMode) |
-
Sets the GridPositionMode attribute.
o SetGridStyleLock
| public virtual SetGridStyleLock( | | iLocked) |
-
Locks or unlocks the GridStyle parameter.
Role: Locks or unlocks the GridStyle parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridStyle
| public virtual SetGridStyle( | | iGridStyle) |
-
Sets the GridStyle attribute.
o SetGridWidthStepLock
| public virtual SetGridWidthStepLock( | | iLocked) |
-
Locks or unlocks the GridWidthStep parameter.
Role: Locks or unlocks the GridWidthStep parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetGridWidthStep
| public virtual SetGridWidthStep( | | iGridWidthStep) |
-
Sets the GridWidthStep attribute.
o SetHidePlaneLock
| public virtual SetHidePlaneLock( | | iLocked) |
-
Locks or unlocks the HidePlane parameter.
Role: Locks or unlocks the HidePlane parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetHidePlane
| public virtual SetHidePlane( | | iHidePlane) |
-
Sets the PlaneAutoHide attribute.
o SetHideResultLock
| public virtual SetHideResultLock( | | iLocked) |
-
Locks or unlocks the HideResult parameter.
Role: Locks or unlocks the HideResult parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetHideResult
| public virtual SetHideResult( | | iHideResult) |
-
Sets the HideResult attribute.
o SetPlaneColorLock
| public virtual SetPlaneColorLock( | | iLocked) |
-
Locks or unlocks the PlaneColor parameter.
Role: Locks or unlocks the PlaneColor parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPlaneColor
| public virtual SetPlaneColor( | | iPlaneColor) |
-
Sets the PlaneColor attribute.
- Parameters:
-
- iPlaneColor:
- Legal values:
Array of 3 unsigned int (R,G,B).
o SetPlaneNormalLock
| public virtual SetPlaneNormalLock( | | iLocked) |
-
Locks or unlocks the PlaneNormal parameter.
Role: Locks or unlocks the PlaneNormal parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPlaneNormal
| public virtual SetPlaneNormal( | | iPlaneNormal) |
-
Sets the PlaneNormal attribute.
o SetPlaneOriginLock
| public virtual SetPlaneOriginLock( | | iLocked) |
-
Locks or unlocks the PlaneOrigin parameter.
Role: Locks or unlocks the PlaneOrigin parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPlaneOrigin
| public virtual SetPlaneOrigin( | | iPlaneOrigin) |
-
Sets the PlaneOrigin attribute.
o SetSectionFillLock
| public virtual SetSectionFillLock( | | iLocked) |
-
Locks or unlocks the SectionFill parameter.
Role: Locks or unlocks the SectionFill parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetSectionFill
| public virtual SetSectionFill( | | iSectionFill) |
-
Sets the SectionFill attribute.
o SetUpdateResultLock
| public virtual SetUpdateResultLock( | | iLocked) |
-
Locks or unlocks the UpdateResult parameter.
Role: Locks or unlocks the UpdateResult parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetUpdateResult
| public virtual SetUpdateResult( | | iUpdateResult) |
-
Sets the UpdateResult attribute.
o SetViewerAutoOpenLock
| public virtual SetViewerAutoOpenLock( | | iLocked) |
-
Locks or unlocks the ViewerAutoOpen parameter.
Role: Locks or unlocks the ViewerAutoOpen parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewerAutoOpen
| public virtual SetViewerAutoOpen( | | iViewerAutoOpen) |
-
Sets the ViewerAutoOpen attribute.
o SetViewerAutoReframeLock
| public virtual SetViewerAutoReframeLock( | | iLocked) |
-
Locks or unlocks the ViewerAutoReframe parameter.
Role: Locks or unlocks the ViewerAutoReframe parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewerAutoReframe
| public virtual SetViewerAutoReframe( | | iViewerAutoReframe) |
-
Sets the ViewerAutoReframe attribute.
o SetViewerLock2DLock
| public virtual SetViewerLock2DLock( | | iLocked) |
-
Locks or unlocks the ViewerLock2D parameter.
Role: Locks or unlocks the ViewerLock2D parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewerLock2D
| public virtual SetViewerLock2D( | | iViewerLock2D) |
-
Sets the ViewerLock2D attribute.
o SetWindowDefaultHeightLock
| public virtual SetWindowDefaultHeightLock( | | iLocked) |
-
Locks or unlocks the WindowDefaultHeight parameter.
Role: Locks or unlocks the WindowDefaultHeight parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetWindowDefaultHeight
| public virtual SetWindowDefaultHeight( | | iWindowDefaultHeight) |
-
Role:Set the section window default height if the
window open mode is catSecWindow_DefaultSize
- Parameters:
-
- iWindowDefaultHeight
-
- Returns:
- S_OK Successfully set the window open mode
E_FAIL Failed to set the window open mode
o SetWindowDefaultWidthLock
| public virtual SetWindowDefaultWidthLock( | | iLocked) |
-
Locks or unlocks the WindowDefaultWidth parameter.
Role: Locks or unlocks the WindowDefaultWidth parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetWindowDefaultWidth
| public virtual SetWindowDefaultWidth( | | iWindowDefaultWidth) |
-
Role:Set the section window default width if the
window open mode is catSecWindow_DefaultSize
- Parameters:
-
- iWindowDefaultWidth
-
- Returns:
- S_OK Successfully set the window open mode
E_FAIL Failed to set the window open mode
o SetWindowOpenModeLock
| public virtual SetWindowOpenModeLock( | | iLocked) |
-
Locks or unlocks the WindowOpenMode parameter.
Role: Locks or unlocks the WindowOpenMode parameter if the
operation is allowed in the current administrated environment. In user mode
this method will always return E_FAIL.
- Parameters:
-
- iLocked
- the locking operation to be performed
Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
o SetWindowOpenMode
| public virtual SetWindowOpenMode( | | iWindowOpenMode) |
-
Role:Set the section window open mode
- Parameters:
-
- iWindowOpenMode
- Legal values:
catSecWindow_DefaultSize :Open the sectioning window(s) with the default size specified in the Tools->Options.
catSecWindow_TileVertically :Tile the sectioning window(s) vertically in the viewer
- Returns:
- Legal values:
S_OK : on Success
E_FAIL: on failure
This object is included in the file: CATISPASectioningSettingAtt.h
If needed, your Imakefile.mk should include the module: CATSaiSpaceAnalysisItf