DG Kernel (ActiveX) Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
What is new
Upgrading Native Apps
Licensing
Collapse ModelsModels
Models
Persistence
Model Properties
Collapse EntitiesEntities
Collapse GeometryGeometry
Geometry
Collapse BRepBRep
BRep Overview
BRep Geometry
Shapes
Curves
Surfaces
Faces
Wires
Edges
Compounds
Collapse MeshMesh
Mesh Geometry
Mesh
BRep to Mesh Conversion
Curve Geometry
Line Strips
Point Sets
Overlays
Collapse AttributesAttributes
Local Frame
Appearance
Texture
Properties of an Entity
Collapse Model ItemsModel Items
Items
3D Text
Smart Labels
View Points
Collapse MeasurementsMeasurements
Measurements
Persistent Measurements
Grid
Collapse Operations and AlgorithmsOperations and Algorithms
Boolean Operations
Euclidean Shortest Path
Collapse MovementMovement
Movements
Kinematic Entities
Collision Detection
Collapse Import/ExportImport/Export
Import/Export Overview
Data Flow Sample
STL Tree
Collapse DG Kernel ControlsDG Kernel Controls
Components
DG Kernel Control
Collapse Properies, Methods, EventsProperies, Methods, Events
Properies
Methods
Events
Collapse Interactive FunctionalityInteractive Functionality
View
Context Menu
Measurements
Direct User Access
Modes of DG Kernel
Current Entities
Collapse Selection OverviewSelection Overview
Selection
Selection Event
Collapse Auxiliary ViewsAuxiliary Views
Model Explorer
Birds Eye View
Full Screen window
Collapse Programmatic FunctionalityProgrammatic Functionality
Programming
Queries
Data Types
Object Construction
Generator
Component Context
Initialisation Context
Collapse API ReferenceAPI Reference
Interface List
Vector Space
Collapse General GeometryGeneral Geometry
IPointArray_DG
IPointMatrix_DG
IPointCloud_DG
Collapse CurvesCurves
ICurve_DG
ILine_DG
ICircle_DG
IEllipse_DG
IBSplineCurve_DG
IBSplineCurveInterpolator_DG
ICurveFreeForm_DG
IArcSpline3DCurve_DG
Collapse 2D2D
ICurve2d_DG
IBSplineCurve2d_DG
ICircle2d_DG
ILine2d_DG
IArc_DG
Collapse SurfacesSurfaces
IUVSurface_DG
IPartialSplineProps_DG
IBSplineSurface_DG
IBezierSurface_DG
IPartialBezierProps_DG
IRectangularTrimmedSurface_DG
ISurfaceOfRevolution_DG
Collapse Oriented ObjectsOriented Objects
IObjectOriented_DG
IPlane_DG
ISphere_DG
ICylinder_DG
ICone_DG
ITorus_DG
IBox_DG
IPolygon3D_DG
IGeometricObject_DG
Collapse GeneralGeneral
IElement_DG
IStrip_DG
Collapse ModelModel
IModel_DG
Collapse EntitiesEntities
IEntity_DG
IEntityArray_DG
IStdShape_DG
IStdShapeRef_DG
IDraw_DG
IEntity2d_DG
IModel2d_DG
Collapse GeometryGeometry
IGeometry_DG
IPointSetGeometry_DG
ISegmentStripGeometry_DG
ICurveGeometry_DG
ISurfacePoint_DG
ISurfacePointArray_DG
ILabel_DG
ILabelGeometry_DG
ISticky_DG
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 Mesh GeometryMesh Geometry
IMesh_DG
IMeshGeometry_DG
IVertex_DG
IVertexSegment_DG
ISimplex_DG
IMeshPoint_DG
IMeshAlgor_DG
IDiffSurface_DG
Collapse AppearenceAppearence
IAppearance_DG
IColor
IMaterial_DG
ITexture_DG
ILineStyle_DG
Collapse MovementMovement
Collapse Collision DetectionCollision Detection
IMetrics_DG
IPathCollisionDetector_DG
IKinematicEntity_DG
IMove_DG
IKinematicSet_DG
ICutEffect_DG
ISpinEffect_DG
IConstraint_DG
Collapse ItemsItems
IModelItem_DG
IItemArray_DG
IDynamicScreenItem_DG
IDynamicScreenItemManager_DG
ISmartLabelManager_DG
Collapse Import / ExportImport / Export
IDataContext_DG
ISTLDataContext_DG
Collapse Operations and AgorithmsOperations and Agorithms
IBooleanEntity_DG
IEuclideanShortestPath_DG
Collapse User DataUser Data
IUserData_DG
Collapse ViewView
IView_DG
ISelection_DG
IScene_DG
ILighting_DG
ILightSource_DG
IViewPoint_DG
IViewPointArray_DG
IMeasurement_DG
IRectangleColor_DG
I2DEditor_DG
IVirtualView_DG
Collapse General ComputingGeneral Computing
IObjectGenerator_DG
IControlInitialisationContext_DG
IGlobalAPI_DG
Collections
IUnknown
IObject_DG
IBitmap_DG
IBlob_DG
IContext_DG
IError_DG
IKCStack
IMenu_KC
IMenuItem_KC
IText
IFont_DG
Collapse ViewsViews
View
Scene
Global Axes
Background
3D Background
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
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
Profiles
Surface Patches
Surfaces and Patch Strips
Input Validation
Collapse Lines and CurvesLines and Curves
3DS Curves
Surface Of Revolution
Collapse Deprecated API ReferenceDeprecated API Reference
Collapse ModelModel
Collapse SectionSection
IBoundary
Collapse 3DS3DS
IProfiles
IProfiledElement_KC
Redistribution
Model Viewer
Open Source
Support
Skip Navigation Links Go to DGKC docs 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