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


IView Interface

GetModel
GetGlobalAxesFlag
ShowGlobalAxes
GetBackColor
SetBackColor
GetRenderType
SetRenderType
Enable
GetEnableFlag
Reset
ResetEx
GetViewType
SetViewType
AddExternalModel
ShowHideAll
GoTo
GetGraphicItem
GetProjectionType
SetProjectionType

IView interface gives access to viewing properties of the control as well as access to ILook interface, which can be queried from IView. IView manages rendering properties which are independent of the current model and its geometry. IView can be obtained from the DG Kernel Control using a call to GetView method 

See also Concepts of 3D Graphics, Modal View Sample, Interface List


HRESULT GetModel( IModel **ppIModel )

Parameters

ppIModel- [out] pointer to an variable of type IModel which will receive the interface.

Returns

S_OK in case of success.

HRESULT GetGlobalAxesFlag( bool *pbShow)

Parameters

pbShow - [out] pointer to a Boolean variable, which will be set to true if global axes are currently displayed

Return Values

S_OK in case of success.
 
Remarks:

HRESULT ShowGlobalAxes( bool bShow)

Parameters

bShow - [in] if true global axes will be drawn 

S_OK in case of success.

HRESULT GetBackColor( long *plCOLORREF )

Parameters

plCOLORREF - [out] pointer to a variable of type long (unsigned 32-bit integer), which will receive COLORREF value of the current background color

Return Values

S_OK in case of success.

Remarks:
 
This property determines background color of the control window. Value of the property need to be cast to COLORREF standard C++/VB data type to use. A call to this method is equivalent to retrieving value of  DIBackColor property of the control.

HRESULT SetBackColor( long lCOLORREF )

Parameters

lCOLORREF - [in] new COLORREF value for the background color

Return Values

S_OK in case of success.

Remarks:
 
This property determines background color of the control window. Value of the property need to be cast to COLORREF standard C++/VB data type to use. A call to this method is equivalent to setting value of  DIBackColor property of the control.
 

HRESULT GetRenderType( int *pnType )

Parameters

lpnType - [out] pointer to an integer variable, which will be set to 1 if control is displaying a surface or 2 if the control is in wire frame drawing mode.

Return Values

S_OK in case of success.

Remarks:
 
Call to determine at runtime rendering type of the control. There are currently two possible values for the render type of the control: 1 if control is displaying a surface or 2 if the control is in wire frame drawing mode. A call to this method is equivalent to retrieving value of  RenederSolid property of the control.
 

HRESULT SetRenderType( int nType )

Parameters

nType  - [in] New render type. If nType equals to 1 the control will be displaying surfaces. if nType equals to 2 the control will display wireframes.

Return Values

S_OK in case of success.

DISP_E_BADINDEX - if nType is neither 1 nor 2.. 

Remarks:
 
Call this method to change display type of the control. A call to this method is equivalent to setting value of  RenederSolid property of the control.

HRESULT Update()

Redraws the view.


HRESULT Enable( int nFlags, VARIANT_BOOL bEnable )

Parameters

nFlags - [in] flags indicating the functionality to enable or disable. See remarks.

bEnable - [in] . The functionality will be enabled (default) if this parameter is true and disabled otherwise.

Returns

S_OK in case of success.

Remarks

nFlags parameter can be one of  EEnableBit members: EEnableBit.eEnablePan ( value=1 ), EEnableBit.eEnableZoom (value = 2), EEnableBit.eEnableRotate (value=4), EEnableBit.eEnableHighLightSurface (value=512), EEnableBit.eEnableTransparency (value=1024) or OR-ed combination of them. .

Using this method with the first three values of the nFlags allows disabling of Pan/Zoom/Rotate viewing manipulations performed on mouse movements. EEnableBit.eEnableHighLightSurface flags enables or disables highlighting the current object in "Modify" mode (See IViewModal and IModel2)). 

EEnableBit.eEnableTransparency (value=1024) enables rendering of objects with alpha material color component < 1 as transparent

EEnableBit.eEnablePerspectiveProjection (value=2048) changes view to prospective mode, where objects, which are further from the viewer appear smaller on the screen. Prospective mode is recommended for viewing only and is not fully supported in this release. Contact us for more information.

EEnableBEEnableBit.eEnableNormals (value=4096)  turns on / off visibility on normals in the 3D view


HRESULT GetEnableFlag( int nFlag, VARIANT_BOOL *pbEnable )

Parameters

nFlag - [in] flag to retrieve.

pbEnable - [out] pointer to a Boolean variable, which will be set to true if the flag is enabled and false otherwise.

Return Values

S_OK in case of success.
Remarks
 
This method returns the current value of the flag. See remarks for the previous method.

HRESULT Reset(VARIANT_BOOL redraw)

Parameters

redraw - [in] if false the control's window will not be redrawn. 

Return Values

S_OK in case of success.

Remarks

This method resets zoom of the view to fit the model into the window and sets point of view to default. The method can be used to programmatically restore initial zoom and orientation after extensive viewing transformations. It is also useful to fit model into the view when size of the model has been changed programmatically. redraw parameter can be used to avoid flickering before some programmatic manipulations of the view.


HRESULT ResetEx(EViewReset action)

Parameters

action - [in] Type of reset to perform

Remarks

When action is eViewResetAll the result is equivalent to call Reset(false) of the previous method.

When action is eViewResetVolume the model will be refit into the window to be fully visible as if on the start of the application, but its current orientation will be preserved.

In more technical terms it means that only Viewing Volume will be modified to center it around the model. Position and orientation of Global and Eye frames will remain unchanged.


HRESULT GetViewType(int *type)

Parameters

type - [out, retval] Current type of the view. Possible return values are enumerated in EViewType enumeration

Remarks

Returns the current type of the view. Possible types are enumerated in EViewType enumeration


HRESULT SetViewType(int type)

Parameters

type - [in] Type of view to activate. Possible types are enumerated in EViewType enumeration

Remarks

This method is not supported in this version


HRESULT AddExternalModel(IModel *model)

Parameters

model - [in] IModel implemented by an external model. See remarks.

Remarks

The method attaches model as an external model to the component which implements this interface. When there is one or more external models attached to the component where this IView2 was queried from on every UpdateSurface call all objects of all external models are replicated and the new copies are added to the main model of the component, which is the model returned by GetModel() method. The replicas added by the pervious call to UpdateSurface are removed before the operation.

The above mechanism allows incorporating model loaded / created independently of the current component or creating multiple views of the same model probably with different display type or point of view.

Note that objects of the external models are. added "By Value", which means that any modifications made to the external model appear in this component only after an UpdateSurface call, not automatically.


HRESULT ShowHideAll(VARIANT_BOOL show)

Remarks

Shows or hides all items in the model


HRESULT GoTo(IItem* iObject)

Remarks

Performs pan and zoom as necessary to focus on the object ( more precisely to fit the object in the window with default margins). Orientation of the view remains the same


HRESULT GetGraphicItem(IObject_KC* object, IGraphicItem** item)

Creates a graphic item for the object and attaches this view to it


HRESULT GetProjectionType(int* type)

Call to query whether the projection is orthographic or perspective. Returns one of values enumerated by E3DViewProjectionType


HRESULT SetProjectionType(int type)

Call to set the projection type to orthographic or perspective. Acceptable values are enumerated by E3DViewProjectionType