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


IDraw Interface

Begin
End
Vertex
Normal
Color
LineWidth
PointSize
PushAttrib
PopAttrib
PushMatrix
PopMatrix
Translate
Rotate
LoadIdentity

IDraw interface gives direct access to the underlying rendering engine. It allows drawing of some elements in the DG Kernel view directly, without having a correspondent object as part of the current model. This method is useful for drawing some auxiliary objects or annotations, which are volatile and should not be stored with the model..

IDraw interface can be obtained via path: Control->GetModel -> IModel ->IDraw. Methods of IDraw must be called as part of handler  for ClientDraw DG Kernel control event.  

IDraw interface is designed to follow closely functionality of OpenGL library interface. Methods of IDraw can be mapped to The OpenGL API by prefixing the methods name with "gl" prefix.  For example Begin() method is mapped to glBegin OpenGL function. This allows using more extensive documentation available for OpenGL.

See also Cannon sample, Interface List


HRESULT Begin(EDrawPrimitive mode)

Parameters

mode- [in] Element of EDrawPrimitive enumeration. 

Remarks:
 Call to this method means that all consequent calls to the Vertex() method before the next End call are related to the current primitive of type mode. Every call to Begin() method should have a correspondent End() call. 

Example:

Sequence: iDraw.Begin( EDrawPrimitive.eTriangles );

                iDraw.Vertex(0.0, 0.0, 0.0);

                iDraw.Vertex(1.0, 0.0, 0.0);

                iDraw.Vertex(0.0, 1.0, 0.0);

                iDraw.End();

will draw a triangle of size 1 in plane x and y of the 3d space.


HRESULT End()

Remarks:
 
Ends sequence of Vertex() calls related to the primitive, which was started with the last Begin call.

HRESULT Vertex(double x, double y, double z)

Parameters

x,y,z - [in] coordinates of the vertex.

Remarks:

This method supplies coordinates of the next vertex for the current primitive drawn between Begin() and End() calls. Coordinates are assumed to be relative to the current drawing frame (See remarks for the Translate method)


HRESULT Normal(double nx, double ny, double nz)

Parameters

nx,ny,nz - [in] coordinates of the normal vector of the current two-dimensional primitive (triangle, quad, etc)

Remarks: Call to Normal method sets the current normal position for the next vertex drawn with a call to Vertex() method of whole primitive, if called once. Coordinates are assumed to be relative to the current drawing frame (See remarks for the Translate method)


HRESULT Color(double red, double green, double blue, double alpha)

Parameters

red, green, blue, alpha [in] - components of the current color, which will be applied to the next vertex of whole primitive if called once. alpha is the transparency component. alpha = 1.0 means the primitive will be opaque. alpha = 0.0 means the primitive will be totally transparent.


HRESULT LineWidth(float width)

Parameters

width - [in] new width in screen pixels that will be used for drawing lines.


HRESULT PointSize(float size)

Parameters

size - [in]

new width in screen pixels which will be used for drawing lines.

HRESULT PushAttrib()

Remarks:

Stores current settings of colour, line width and point size on a stack. Use PopAttrib() to restore settings stored with this method call.


HRESULT PopAttrib()

Remarks:

Restores colour, line width and point which where current at the last call to PushAttrib() method.

HRESULT PushMatrix()

Remarks:

Stores position and orientation of the current drawing frame before performing any transformations using Translate or Rotate methods. 


HRESULT PopMatrix()

Remarks:

Restores position and orientation of the current drawing frame which was current at the last call to PushMatrix() method.

HRESULT Translate(double vx, double vy, double vz)

Parameters

vx,vy,vy - [in] coordinates of the translation vector

Remarks:

Modifies position of the local Drawing Frame. All Vertex() calls refer to coordinates in the local drawing frame, so that result of drawing command depends on the position and orientation of the frame. At the first call to OnClientDraw() DG Kernel event handler position of the current frame coincides with the global axes. As the result of this method position of the current frame will be changed by the translation vector above.  


HRESULT Rotate(double angle, double vx, double vy, double vz)

Parameters

angle -  angle in degrees to rotate by.

vx,vy,vy - [in] coordinates of the axis of rotation. 

Remarks:

Modifies orientation of the local drawing frame (See remarks for the Translate method) As the result of this method position of the current frame will be rotated by angle around the above axis. 


HRESULT LoadIdentity()

Remarks:

Resets orientation and position of the local drawing frame (See remarks for the Translate method) As the result of this method the current frame will coincide with the global 3D frame