All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SpaceAnalysisInterfaces Interface CATISPASectioningSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 GetClippingMode(CatSectionClippingMode*)
Retrieves the ClippingMode attribute.
o GetClippingModeInfo(CATSettingInfo*)
Retrieves the state of the ClippingMode parameter.
o GetDisplayCutInWireframe(int*)
Retrieves the DisplayCutInWireframe attribute.
o GetDisplayCutInWireframeInfo(CATSettingInfo*)
Retrieves the state of the DisplayCutInWireframe parameter.
o GetGridAutoFiltering(int*)
Retrieves the GridAutoFiltering attribute.
o GetGridAutoFilteringInfo(CATSettingInfo*)
Retrieves the state of the GridAutoFiltering parameter.
o GetGridAutoResize(int*)
Retrieves the GridAutoResize attribute.
o GetGridAutoResizeInfo(CATSettingInfo*)
Retrieves the state of the GridAutoResize parameter.
o GetGridHeightStep(float*)
Retrieves the GridHeightStep attribute.
o GetGridHeightStepInfo(CATSettingInfo*)
Retrieves the state of the GridHeightStep parameter.
o GetGridPositionMode(CatGridPositionMode*)
Retrieves the GridPositionMode attribute.
o GetGridPositionModeInfo(CATSettingInfo*)
Retrieves the state of the GridPositionMode parameter.
o GetGridStyle(CatSectionGridStyle*)
Retrieves the GridStyle attribute.
o GetGridStyleInfo(CATSettingInfo*)
Retrieves the state of the GridStyle parameter.
o GetGridWidthStep(float*)
Retrieves the GridWidthStep attribute.
o GetGridWidthStepInfo(CATSettingInfo*)
Retrieves the state of the GridWidthStep parameter.
o GetHidePlane(int*)
Retrieves the HidePlane attribute.
o GetHidePlaneInfo(CATSettingInfo*)
Retrieves the state of the HidePlane parameter.
o GetHideResult(int*)
Retrieves the HideResult attribute.
o GetHideResultInfo(CATSettingInfo*)
Retrieves the state of the HideResult parameter.
o GetPlaneColor(unsigned int*)
Retrieves the PlaneColor attribute.
o GetPlaneColorInfo(CATSettingInfo*)
Retrieves the state of the PlaneColor parameter.
o GetPlaneNormal(CatSectionPlaneNormal*)
Retrieves the PlaneNormal attribute.
o GetPlaneNormalInfo(CATSettingInfo*)
Retrieves the state of the PlaneNormal parameter.
o GetPlaneOrigin(CatSectionPlaneOrigin*)
Retrieves the PlaneOrigin attribute.
o GetPlaneOriginInfo(CATSettingInfo*)
Retrieves the state of the PlaneOrigin parameter.
o GetSectionFill(int*)
Retrieves the SectionFill attribute.
o GetSectionFillInfo(CATSettingInfo*)
Retrieves the state of the SectionFill parameter.
o GetUpdateResult(int*)
Retrieves the UpdateResult attribute.
o GetUpdateResultInfo(CATSettingInfo*)
Retrieves the state of the UpdateResult parameter.
o GetViewerAutoOpen(int*)
Retrieves the ViewerAutoOpen attribute.
o GetViewerAutoOpenInfo(CATSettingInfo*)
Retrieves the state of the ViewerAutoOpen parameter.
o GetViewerAutoReframe(int*)
Retrieves the ViewerAutoReframe attribute.
o GetViewerAutoReframeInfo(CATSettingInfo*)
Retrieves the state of the ViewerAutoReframe parameter.
o GetViewerLock2D(int*)
Retrieves the ViewerLock2D attribute.
o GetViewerLock2DInfo(CATSettingInfo*)
Retrieves the state of the ViewerLock2D parameter.
o GetWindowDefaultHeight(int&)

Role:Retrieve section window default height if the window open mode is catSecWindow_DefaultSize
o GetWindowDefaultHeightInfo(CATSettingInfo*)
Retrieves the state of the WindowDefaultHeight parameter.
o GetWindowDefaultWidth(int&)

Role:Retrieve section window default width if the window open mode is catSecWindow_DefaultSize
o GetWindowDefaultWidthInfo(CATSettingInfo*)
Retrieves the state of the WindowDefaultWidth parameter.
o GetWindowOpenMode(CatSecWindowOpenMode&)

Role: Get section window open mode
o GetWindowOpenModeInfo(CATSettingInfo*)
Retrieves the state of the WindowOpenMode parameter.
o SetClippingMode(CatSectionClippingMode*)
Sets the ClippingMode attribute.
o SetClippingModeLock(unsigned char)
Locks or unlocks the ClippingMode parameter.
o SetDisplayCutInWireframe(int*)
Sets the DisplayCutInWireframe attribute.
o SetDisplayCutInWireframeLock(unsigned char)
Locks or unlocks the DisplayCutInWireframe parameter.
o SetGridAutoFiltering(int*)
Sets the GridAutoFiltering attribute.
o SetGridAutoFilteringLock(unsigned char)
Locks or unlocks the GridAutoFiltering parameter.
o SetGridAutoResize(int*)
Sets the GridAutoResize attribute.
o SetGridAutoResizeLock(unsigned char)
Locks or unlocks the GridAutoResize parameter.
o SetGridHeightStep(float*)
Sets the GridHeightStep attribute.
o SetGridHeightStepLock(unsigned char)
Locks or unlocks the GridHeightStep parameter.
o SetGridPositionMode(CatGridPositionMode*)
Sets the GridPositionMode attribute.
o SetGridPositionModeLock(unsigned char)
Locks or unlocks the GridPositionMode parameter.
o SetGridStyle(CatSectionGridStyle*)
Sets the GridStyle attribute.
o SetGridStyleLock(unsigned char)
Locks or unlocks the GridStyle parameter.
o SetGridWidthStep(float*)
Sets the GridWidthStep attribute.
o SetGridWidthStepLock(unsigned char)
Locks or unlocks the GridWidthStep parameter.
o SetHidePlane(int*)
Sets the PlaneAutoHide attribute.
o SetHidePlaneLock(unsigned char)
Locks or unlocks the HidePlane parameter.
o SetHideResult(int*)
Sets the HideResult attribute.
o SetHideResultLock(unsigned char)
Locks or unlocks the HideResult parameter.
o SetPlaneColor(unsigned int*)
Sets the PlaneColor attribute.
o SetPlaneColorLock(unsigned char)
Locks or unlocks the PlaneColor parameter.
o SetPlaneNormal(CatSectionPlaneNormal*)
Sets the PlaneNormal attribute.
o SetPlaneNormalLock(unsigned char)
Locks or unlocks the PlaneNormal parameter.
o SetPlaneOrigin(CatSectionPlaneOrigin*)
Sets the PlaneOrigin attribute.
o SetPlaneOriginLock(unsigned char)
Locks or unlocks the PlaneOrigin parameter.
o SetSectionFill(int*)
Sets the SectionFill attribute.
o SetSectionFillLock(unsigned char)
Locks or unlocks the SectionFill parameter.
o SetUpdateResult(int*)
Sets the UpdateResult attribute.
o SetUpdateResultLock(unsigned char)
Locks or unlocks the UpdateResult parameter.
o SetViewerAutoOpen(int*)
Sets the ViewerAutoOpen attribute.
o SetViewerAutoOpenLock(unsigned char)
Locks or unlocks the ViewerAutoOpen parameter.
o SetViewerAutoReframe(int*)
Sets the ViewerAutoReframe attribute.
o SetViewerAutoReframeLock(unsigned char)
Locks or unlocks the ViewerAutoReframe parameter.
o SetViewerLock2D(int*)
Sets the ViewerLock2D attribute.
o SetViewerLock2DLock(unsigned char)
Locks or unlocks the ViewerLock2D parameter.
o SetWindowDefaultHeight(int)

Role:Set the section window default height if the window open mode is catSecWindow_DefaultSize
o SetWindowDefaultHeightLock(unsigned char)
Locks or unlocks the WindowDefaultHeight parameter.
o SetWindowDefaultWidth(int)

Role:Set the section window default width if the window open mode is catSecWindow_DefaultSize
o SetWindowDefaultWidthLock(unsigned char)
Locks or unlocks the WindowDefaultWidth parameter.
o SetWindowOpenMode(CatSecWindowOpenMode)

Role:Set the section window open mode
o SetWindowOpenModeLock(unsigned char)
Locks or unlocks the WindowOpenMode parameter.

Methods


o GetClippingMode
public virtual HRESULT GetClippingMode(CatSectionClippingMode* oClippingMode)= 0
Retrieves the ClippingMode attribute.
o GetClippingModeInfo
public virtual HRESULT GetClippingModeInfo(CATSettingInfo* oInfo)= 0
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 GetDisplayCutInWireframe
public virtual HRESULT GetDisplayCutInWireframe(int* oDisplayCutInWireframe)= 0
Retrieves the DisplayCutInWireframe attribute.
o GetDisplayCutInWireframeInfo
public virtual HRESULT GetDisplayCutInWireframeInfo(CATSettingInfo* oInfo)= 0
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 GetGridAutoFiltering
public virtual HRESULT GetGridAutoFiltering(int* oGridAutoFiltering)= 0
Retrieves the GridAutoFiltering attribute.
o GetGridAutoFilteringInfo
public virtual HRESULT GetGridAutoFilteringInfo(CATSettingInfo* oInfo)= 0
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 GetGridAutoResize
public virtual HRESULT GetGridAutoResize(int* oGridAutoResize)= 0
Retrieves the GridAutoResize attribute.
o GetGridAutoResizeInfo
public virtual HRESULT GetGridAutoResizeInfo(CATSettingInfo* oInfo)= 0
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 GetGridHeightStep
public virtual HRESULT GetGridHeightStep(float* oGridHeightStep)= 0
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 GetGridHeightStepInfo
public virtual HRESULT GetGridHeightStepInfo(CATSettingInfo* oInfo)= 0
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 GetGridPositionMode
public virtual HRESULT GetGridPositionMode(CatGridPositionMode* oGridPositionMode)= 0
Retrieves the GridPositionMode attribute.
o GetGridPositionModeInfo
public virtual HRESULT GetGridPositionModeInfo(CATSettingInfo* oInfo)= 0
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 GetGridStyle
public virtual HRESULT GetGridStyle(CatSectionGridStyle* oGridStyle)= 0
Retrieves the GridStyle attribute.
o GetGridStyleInfo
public virtual HRESULT GetGridStyleInfo(CATSettingInfo* oInfo)= 0
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 GetGridWidthStep
public virtual HRESULT GetGridWidthStep(float* oGridWidthStep)= 0
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 GetGridWidthStepInfo
public virtual HRESULT GetGridWidthStepInfo(CATSettingInfo* oInfo)= 0
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 GetHidePlane
public virtual HRESULT GetHidePlane(int* oHidePlane)= 0
Retrieves the HidePlane attribute.
o GetHidePlaneInfo
public virtual HRESULT GetHidePlaneInfo(CATSettingInfo* oInfo)= 0
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 GetHideResult
public virtual HRESULT GetHideResult(int* oHideResult)= 0
Retrieves the HideResult attribute.
o GetHideResultInfo
public virtual HRESULT GetHideResultInfo(CATSettingInfo* oInfo)= 0
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 GetPlaneColor
public virtual HRESULT GetPlaneColor(unsigned int* oPlaneColor)= 0
Retrieves the PlaneColor attribute.
Parameters:
ioPlaneColor:
Legal values:
Array of 3 unsigned int (R,G,B).
o GetPlaneColorInfo
public virtual HRESULT GetPlaneColorInfo(CATSettingInfo* oInfo)= 0
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 GetPlaneNormal
public virtual HRESULT GetPlaneNormal(CatSectionPlaneNormal* oPlaneNormal)= 0
Retrieves the PlaneNormal attribute.
o GetPlaneNormalInfo
public virtual HRESULT GetPlaneNormalInfo(CATSettingInfo* oInfo)= 0
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 GetPlaneOrigin
public virtual HRESULT GetPlaneOrigin(CatSectionPlaneOrigin* oPlaneOrigin)= 0
Retrieves the PlaneOrigin attribute.
o GetPlaneOriginInfo
public virtual HRESULT GetPlaneOriginInfo(CATSettingInfo* oInfo)= 0
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 GetSectionFill
public virtual HRESULT GetSectionFill(int* oSectionFill)= 0
Retrieves the SectionFill attribute.
o GetSectionFillInfo
public virtual HRESULT GetSectionFillInfo(CATSettingInfo* oInfo)= 0
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 GetUpdateResult
public virtual HRESULT GetUpdateResult(int* oUpdateResult)= 0
Retrieves the UpdateResult attribute.
o GetUpdateResultInfo
public virtual HRESULT GetUpdateResultInfo(CATSettingInfo* oInfo)= 0
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 GetViewerAutoOpen
public virtual HRESULT GetViewerAutoOpen(int* oViewerAutoOpen)= 0
Retrieves the ViewerAutoOpen attribute.
o GetViewerAutoOpenInfo
public virtual HRESULT GetViewerAutoOpenInfo(CATSettingInfo* oInfo)= 0
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 GetViewerAutoReframe
public virtual HRESULT GetViewerAutoReframe(int* oViewerAutoReframe)= 0
Retrieves the ViewerAutoReframe attribute.
o GetViewerAutoReframeInfo
public virtual HRESULT GetViewerAutoReframeInfo(CATSettingInfo* oInfo)= 0
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 GetViewerLock2D
public virtual HRESULT GetViewerLock2D(int* oViewerLock2D)= 0
Retrieves the ViewerLock2D attribute.
o GetViewerLock2DInfo
public virtual HRESULT GetViewerLock2DInfo(CATSettingInfo* oInfo)= 0
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 GetWindowDefaultHeight
public virtual HRESULT GetWindowDefaultHeight(int& oWindowDefaultHeight)=0

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 GetWindowDefaultHeightInfo
public virtual HRESULT GetWindowDefaultHeightInfo(CATSettingInfo* oInfo)= 0
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 GetWindowDefaultWidth
public virtual HRESULT GetWindowDefaultWidth(int& oWindowDefaultWidth)= 0

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 GetWindowDefaultWidthInfo
public virtual HRESULT GetWindowDefaultWidthInfo(CATSettingInfo* oInfo)= 0
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 GetWindowOpenMode
public virtual HRESULT GetWindowOpenMode(CatSecWindowOpenMode& oWindowOpenMode) = 0

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 GetWindowOpenModeInfo
public virtual HRESULT GetWindowOpenModeInfo(CATSettingInfo* oInfo)= 0
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 SetClippingMode
public virtual HRESULT SetClippingMode(CatSectionClippingMode* iClippingMode)= 0
Sets the ClippingMode attribute.
o SetClippingModeLock
public virtual HRESULT SetClippingModeLock(unsigned char iLocked)= 0
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 SetDisplayCutInWireframe
public virtual HRESULT SetDisplayCutInWireframe(int* iDisplayCutInWireframe)= 0
Sets the DisplayCutInWireframe attribute.
o SetDisplayCutInWireframeLock
public virtual HRESULT SetDisplayCutInWireframeLock(unsigned char iLocked)= 0
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 SetGridAutoFiltering
public virtual HRESULT SetGridAutoFiltering(int* iGridAutoFiltering)= 0
Sets the GridAutoFiltering attribute.
o SetGridAutoFilteringLock
public virtual HRESULT SetGridAutoFilteringLock(unsigned char iLocked)= 0
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 SetGridAutoResize
public virtual HRESULT SetGridAutoResize(int* iGridAutoResize)= 0
Sets the GridAutoResize attribute.
o SetGridAutoResizeLock
public virtual HRESULT SetGridAutoResizeLock(unsigned char iLocked)= 0
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 SetGridHeightStep
public virtual HRESULT SetGridHeightStep(float* iGridHeightStep)= 0
Sets the GridHeightStep attribute.
o SetGridHeightStepLock
public virtual HRESULT SetGridHeightStepLock(unsigned char iLocked)= 0
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 SetGridPositionMode
public virtual HRESULT SetGridPositionMode(CatGridPositionMode* iGridPositionMode)= 0
Sets the GridPositionMode attribute.
o SetGridPositionModeLock
public virtual HRESULT SetGridPositionModeLock(unsigned char iLocked)= 0
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 SetGridStyle
public virtual HRESULT SetGridStyle(CatSectionGridStyle* iGridStyle)= 0
Sets the GridStyle attribute.
o SetGridStyleLock
public virtual HRESULT SetGridStyleLock(unsigned char iLocked)= 0
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 SetGridWidthStep
public virtual HRESULT SetGridWidthStep(float* iGridWidthStep)= 0
Sets the GridWidthStep attribute.
o SetGridWidthStepLock
public virtual HRESULT SetGridWidthStepLock(unsigned char iLocked)= 0
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 SetHidePlane
public virtual HRESULT SetHidePlane(int* iHidePlane)= 0
Sets the PlaneAutoHide attribute.
o SetHidePlaneLock
public virtual HRESULT SetHidePlaneLock(unsigned char iLocked)= 0
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 SetHideResult
public virtual HRESULT SetHideResult(int* iHideResult)= 0
Sets the HideResult attribute.
o SetHideResultLock
public virtual HRESULT SetHideResultLock(unsigned char iLocked)= 0
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 SetPlaneColor
public virtual HRESULT SetPlaneColor(unsigned int* iPlaneColor)= 0
Sets the PlaneColor attribute.
Parameters:
iPlaneColor:
Legal values:
Array of 3 unsigned int (R,G,B).
o SetPlaneColorLock
public virtual HRESULT SetPlaneColorLock(unsigned char iLocked)= 0
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 SetPlaneNormal
public virtual HRESULT SetPlaneNormal(CatSectionPlaneNormal* iPlaneNormal)= 0
Sets the PlaneNormal attribute.
o SetPlaneNormalLock
public virtual HRESULT SetPlaneNormalLock(unsigned char iLocked)= 0
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 SetPlaneOrigin
public virtual HRESULT SetPlaneOrigin(CatSectionPlaneOrigin* iPlaneOrigin)= 0
Sets the PlaneOrigin attribute.
o SetPlaneOriginLock
public virtual HRESULT SetPlaneOriginLock(unsigned char iLocked)= 0
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 SetSectionFill
public virtual HRESULT SetSectionFill(int* iSectionFill)= 0
Sets the SectionFill attribute.
o SetSectionFillLock
public virtual HRESULT SetSectionFillLock(unsigned char iLocked)= 0
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 SetUpdateResult
public virtual HRESULT SetUpdateResult(int* iUpdateResult) = 0
Sets the UpdateResult attribute.
o SetUpdateResultLock
public virtual HRESULT SetUpdateResultLock(unsigned char iLocked)= 0
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 SetViewerAutoOpen
public virtual HRESULT SetViewerAutoOpen(int* iViewerAutoOpen)= 0
Sets the ViewerAutoOpen attribute.
o SetViewerAutoOpenLock
public virtual HRESULT SetViewerAutoOpenLock(unsigned char iLocked)= 0
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 SetViewerAutoReframe
public virtual HRESULT SetViewerAutoReframe(int* iViewerAutoReframe)= 0
Sets the ViewerAutoReframe attribute.
o SetViewerAutoReframeLock
public virtual HRESULT SetViewerAutoReframeLock(unsigned char iLocked)= 0
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 SetViewerLock2D
public virtual HRESULT SetViewerLock2D(int* iViewerLock2D)= 0
Sets the ViewerLock2D attribute.
o SetViewerLock2DLock
public virtual HRESULT SetViewerLock2DLock(unsigned char iLocked)= 0
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 SetWindowDefaultHeight
public virtual HRESULT SetWindowDefaultHeight(int iWindowDefaultHeight)=0

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 SetWindowDefaultHeightLock
public virtual HRESULT SetWindowDefaultHeightLock(unsigned char iLocked)= 0
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 SetWindowDefaultWidth
public virtual HRESULT SetWindowDefaultWidth(int iWindowDefaultWidth)= 0

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 SetWindowDefaultWidthLock
public virtual HRESULT SetWindowDefaultWidthLock(unsigned char iLocked)= 0
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 SetWindowOpenMode
public virtual HRESULT SetWindowOpenMode(CatSecWindowOpenMode iWindowOpenMode)= 0

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
o SetWindowOpenModeLock
public virtual HRESULT SetWindowOpenModeLock(unsigned char iLocked)= 0
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

This object is included in the file: CATISPASectioningSettingAtt.h
If needed, your Imakefile.mk should include the module: CATSaiSpaceAnalysisItf

Copyright © 2003, Dassault Systèmes. All rights reserved.