DG Kernel Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
Overview of the software
What is new
Licensing
Collapse ModelsModels
Collapse DG Kernel ComponentsDG Kernel Components
Collapse API ReferenceAPI Reference
Interface List
Vector Space
Collapse General GeometryGeneral Geometry
Collapse ModelModel
Collapse ViewView
Collapse General ComputingGeneral Computing
Collapse Samples and TutorialsSamples and Tutorials
Collapse GraphicsGraphics
Collapse Math ObjectsMath Objects
Collapse DeprecatedDeprecated
Redistribution
Model Viewer
Open Source
Support
Skip Navigation Links Search Documentation


IClipArray Interface

IsEnabled
Enable
GetClipPlane

Manages set of six clipping planes of a object.

See also IClipPlane interface, Clip Planes, Interface List


HRESULT IsEnabled( int nPlane, bool * pbEnabled)

Parameters

nPlane - [in] index of the plane - integer value between 0 and 5.

pbEnabled- [out] pointer to the Boolean variable, which will be set to true if the plane is enabled 

Return Values

S_OK in case of success.

Remarks

Retrieves status of the plane nPlane. If it is not enabled it has no effect on the model. This method is a shortcut for IsEnabled method from IClipPlane interface


HRESULT Enable( int nPlane, bool bEnable)

Parameters

nPlane - [in] index of the plane - integer value between 0 and 5.

bEnable - [in] new value for enabled status of the plane. 

Return Values

S_OK in case of success.

Remarks

Changes status of the plane nPlane. If it is not enabled it has no effect on the model. This method is a shortcut for Enable method from IClipPlane interface


HRESULT GetClipPlane( int nPlane, IClipPlane **ppIPlane)

Parameters

nPlane - [in] index of the plane - integer value between 0 and 5.

ppIPlane - [out] pointer to a IClipPlane* variable, which will receive pointer to IClipPlane interface implemented by the plane.

Return Values

S_OK in case of success.

Remarks

Retrieves IClipPlane interface implemented by plane nPlane