DG Kernel Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
Overview of the software
What is new
Licensing
Collapse ModelsModels
Models
Persistence
Collapse EntitiesEntities
Collapse GeometryGeometry
Geometry
Collapse BSpline BRepBSpline BRep
BSpline BRep Overview
BSpline Geometry
Curves
Faces
Wires
Edges
Collapse MeshMesh
Mesh Geometry
Mesh
Line Strips
Point Sets
Collapse Entity AttributesEntity Attributes
Local Frame
Material
Texture
Clipping Planes
Properties of an Entity
3D Grid
Collapse Model ItemsModel Items
Items
View Points
Collapse MeasurementsMeasurements
Measurements
Persistent Measurements
Grid
Collapse Operations and AlgorithmsOperations and Algorithms
Boolean Operations
Euclidean Shortest Path
Collapse MovementMovement
Movements
Kinematic Sections
Collision Detection
Collapse Import/ExportImport/Export
Import/Export Overview
Data Flow Sample
STL Tree
Collapse DG Kernel ComponentsDG Kernel Components
Components
DG Kernel Control
Collapse Properies, Methods, EventsProperies, Methods, Events
Properies
Methods
Events
Collapse Interactive FunctionalityInteractive Functionality
Context Menu
Measurements
Direct User Access
Modes of DG Kernel
Current Entities
Collapse View of DGK ControlView of DGK Control
Global Axes
Background
3D Background
Collapse Selection OverviewSelection Overview
Selection
Selection Event
Collapse Auxiliary ViewsAuxiliary Views
Model Explorer
Birds Eye View
Full Screen window
Collapse Programmatic FunctionalityProgrammatic Functionality
Programming
Porting V5 Apps to DGK
Queries
Data Types
Object Construction
Generator
Component Context
Model Properties
Initialisation Context
Collapse AdvancedAdvanced
64 Bit Development
Memory Management
Third Party Technologies
Collapse API ReferenceAPI Reference
Interface List
Vector Space
Collapse General GeometryGeneral Geometry
IPointArray_DG
IPointMatrix_DG
Collapse CurvesCurves
ICurve_DG
ICircle_DG
ILine_DG
IBSplineCurve_DG
IBSplineCurveInterpolator_DG
ICurveFreeForm
ICurveFreeFormEx
IArcSpline3DCurve
Collapse 2D2D
ICurve2d_DG
IBSplineCurve2d_DG
ICircle2d_DG
ILine2D
IArc
IArcEx
IEllipse_KC
IStripArcLine_KC
Collapse Oriented ObjectsOriented Objects
IObjectOriented
IPlane_DG
ISphere_DG
ICylinder_DG
ICone_DG
ITorus_DG
IBox_DG
IPolygon3D_DG
IPrizmInfinite_KC
IUVSurface_DG
IGeometricObject_DG
IPartialSplineProps_DG
IBSplineSurface_DG
ISurface
IRectangleAxisAligned_KC
Collapse GeneralGeneral
IStrip
IStripTopol
IElem
IElement
ILocation
ILocationEx
Collapse ModelModel
IModel_DG
Collapse EntitiesEntities
IEntity_DG
IEntityArray_DG
IStdShape_DG
IStdShapeRef_DG
IDraw_DG
IConstraint
Collapse GeometryGeometry
IGeometry_DG
ISurfacePoint_DG
ISurfaceMetric_KC
Collapse BSpline BRep GeometryBSpline BRep Geometry
Collapse Advanced AlgorithmsAdvanced Algorithms
IBRepChamfer_DG
IBRepDraftAngle_DG
IBRepFillet_DG
IFeaturePrism_DG
IBRepShape_DG
IBRepVertex_DG
IBRepEdge_DG
IBRepWire_DG
IBRepFace_DG
IBRepShell_DG
IBRepSolid_DG
IBRepCompositeSolid_DG
IBRepCompound_DG
IShapeArray_DG
IBRepBuilderEx_DG
IWireArrayToSurfaceBuilder_DG
IBRepGeometry_DG
IBRepBuilder_DG
Collapse Native OCCTNative OCCT
IIKO_Standard_Object
IKO_Model
IKO_TopExp_Explorer
BRep
BRepBuilderAPI
BRepExtrema
BRepOffsetAPI
BRepPrimAPI
Geom2d
GeomAPI
GP
ModModeling Algorithms
TColgp
TColStd
TopoDS
TopTools
Collapse Mesh GeometryMesh Geometry
IMesh
IMeshTopol
ISimplex
IMeshMods
IVertex
IMeshEx
IMeshPointKC
IVertexEx_KC
IEdge_KC
ISimplexEx_KC
IMeshAlgor
IMeshBuilder_KC
IMeshShading_KC
Collapse AppearenceAppearence
IAppearance_DG
IColor
IMaterial
ITexture
ILineStyle_KC
Collapse MovementMovement
Collapse Collision DetectionCollision Detection
IMetrics
IMetrics2
IKCPathCollisionDetector
IKinematicSection_KC
IMove_KC
IKinematicSet_KC
ICutEffect_KC
ISpinEffect_KC
Collapse ItemsItems
IModelItem_DG
IItemArray_DG
Collapse Import / ExportImport / Export
ICADFormat_KC
IDataContext
IFormatVersionDataContext
ISTLDataContext
IDataConvert_KC
Collapse Operations and AgorithmsOperations and Agorithms
IBooleanEntity_DG
IBoolSectionEx
ITransform
IDiffSurface_KC
IEuclideanShortestPath_KC
Collapse User DataUser Data
ILayers
IUserData_DG
IMatrixData
Collapse ViewView
IView_DG
ISelection_DG
IViewPoint
IViewPointArray
IScene_DG
IRectangleColor_KC
I2DView_KC
I2DView2_KC
I2DEditor_KC
IPrint_KC
IVirtualView
ILightSource
I3DGrid
Collapse General ComputingGeneral Computing
IObjectGenerator_DG
IControlInitialisationContext_KC
Collections
IUnknown
IObject_DG
ITypeBasic_KC
IBitmap
IBlob
IKCContext
IKCContext2
IError_KC
IKCStack
IMenu_KC
IMenuItem_KC
IGlobalAPI_KC
IRange
IText
IDIFont
I3DBugger
Collapse Embedded User DBEmbedded User DB
IData
Collapse Samples and TutorialsSamples and Tutorials
Sample List
.NET Samples
Delphi and C++ Samples
Collapse GraphicsGraphics
Concepts
3D View
Viewing Volume
Eye Frame
Perspective View
Collapse Math ObjectsMath Objects
Mathematical Objects
Points and Vectors
Planes
Frames
Transforms
Oriented Objects
Boxes
Collapse CurvesCurves
Curve Technologies
Native Curves
Collapse 2D Elements2D Elements
Geometric Elements
Arcs
Line Strips
Collapse DeprecatedDeprecated
Collapse Deprecated GeometryDeprecated Geometry
Collapse 3DS3DS
3DS Generator
Profiles
Surface Patches
Surfaces and Patch Strips
Input Validation
Collapse Lines and CurvesLines and Curves
Line Section
3DS Curves
Surface Of Revolution
Pipes
Collapse Deprecated API ReferenceDeprecated API Reference
Vector Space
General Geometry
Collapse ModelModel
IModel
IModel2
IModelEx
IModelSearch_KC
Collapse SectionSection
IBoundary
IStdShape
ISurfacePointKC
ISurfacePointArrayKC
IBoolSection
ISection
ISection2
ISectionPointSet
ISectionLineStrip
IPipeSection
ILineSection_KC
IObjectPosition_KC
IModelHealer_KC
IPointCloud_KC
Collapse 3DS3DS
I3DSectionGenerator
IAxiBase
IProfiles
IProfiledElement_KC
Collapse SORSOR
ISORSectionGenerator
Clipping Planes
IDraw
IDrawUtil
IDraw2
View
Collapse General ComputingGeneral Computing
IDIObjGenerator
IObject_KC
Collapse CollectionsCollections
IArray
IArray2
IList
IListUnkn_KC
IRelation
IArrayNum
IArray3D
IRefMap_KC
Redistribution
Model Viewer
Open Source
Support
Skip Navigation Links Search Documentation


IClipPlane Interface

IsEnabled
Enable
GetNormal
Share
GetID
UseShared
SelectSide
SetClipChildren
GetClipChildren
Show
GetShow

Manages set of six clipping planes of a object.

See also Clip Planes, Clip EditorInterface List


HRESULT IsEnabled( bool * pbEnabled)

Parameters

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 enabled status of the plane. If it is not enabled it has no effect on the model.


HRESULT Enable( bool bEnable)

Parameters

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

Return Values

S_OK in case of success.

Remarks

Changes status of the plane. If it is not enabled it has no effect on the model.


HRESULT GetNormal( IAxis **ppIAxis )

Parameters

ppIPAxis - [out] pointer to a IAxis* variable, which will receive pointer to IAxis interface, representing normal of the plane, implemented by the plane. 

Return Values

S_OK in case of success. 
DISP_E_PARAMNOTOPTIONAL - if ppIAxis is NULL

Remarks

Retrieves IAxis interface, representing normal of the plane, implemented by the plane. IAxis interface will allow changing position and orientation of the plane. 


HRESULT Share( bool bShare )

Parameters

bShare - [in] Bollean parameter. If it is true the plane will be available for use by other objects  in the model. 

Return Values

S_OK in case of success.

Remarks

When Share method is called with true parameter the clipping plane becomes available for use by other planes in the model. It is also becomes a global plane, so when the current object is moved in 3D the plane will keep its global position and orientation unchanged. To use this plane in another object. retrieve ID of this plane with GetID method and call UseShared method on IClipPlane interface of the object which will use it supplying this ID .

When Share method is called with false  parameter the clipping plane stops being shared, so it will clip only the object it belongs to (where IClipArray was retrieved from). It is also becomes a local plane, so when the current object is moved in 3D the plane will move with the local frame.


HRESULT GetID( long *plID )

Parameters

pplID - [out] pointer to a variable of long integer type, which will receive ID of this plane. If this plane is not shared the ID will be equal to 0.

Return Values

S_OK in case of success.
DISP_E_PARAMNOTOPTIONAL - if ppIAxis is NULL

Remarks

Retrieves ID of this plane when it is shared. The id can be used in a call to UseShared method of IClipPlane interface implemented by another object of  the model.


HRESULT UseShared( long lID )

Parameters

lID- [in] ID of a shared clipping plane.

Return Values

S_OK in case of success.

Remarks

After this call the current object will be clipped by global plane IID which normally clips two or more objects. Thsi allows synchronization of clipping operation between different objects. See also SelectSide method


HRESULT SelectSide(bool bPositive)

Parameters

bPositive- [in] if true part of the object on the positive side of the clipping plane will remain visible.

Return Values

S_OK in case of success.

Remarks

Allows selection on which side of the clipping plane the object will be cut off. Positive is the side where normal of the plane points into.


HRESULT SetClipChildren(bool bClip)

Parameters

bClip- [in] if true all children objects will be clipped by this plane

Return Values

S_OK in case of success.

Remarks

Allows to enable or disable clipping of children objects by this plane


HRESULT GetClipChildren(bool * pbClip)

Parameters

pbClip- [out] Reference to a Boolean variable, which will be set to true or false depending whether clipping of child object is enabled or not. 

Return Values

S_OK in case of success.
DISP_E_PARAMNOTOPTIONAL - if pbClip is NULL

Remarks

Allows selection of on which side of the clipping plane the object will be cut off. Positive is the side where normal of the plane points into.

 


HRESULT Show(VARIANT_BOOL show)

Parameters

show - [in] New value for the Show property

Return Values

S_OK in case of success.
DISP_E_PARAMNOTOPTIONAL - if pbClip is NULL

Remarks

If show is true. The plane will rendered in 3D as a disk to display its location and orientation, which can be used for debugging purposes. Color of the disk, including transparency, can be controlled by queering IColor from IClipPlane.


HRESULT GetShow(VARIANT_BOOL *show)

Parameters

show - [out] The current value of the Show property

Return Values

S_OK in case of success.
DISP_E_PARAMNOTOPTIONAL - if pbClip is NULL

Remarks

Returns the current value of the Show property, which determines whether the plane is rendered as a disk element. Color of the disk, including transparency, can be controlled by queering IColor from IClipPlane.