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


IModel Interface

GetEntityCount
GetEntity
Save
Update
GetModelPath
GetItemCount
GetItem

See also IModel2, Interface List, Patch Programming Tutorial, MiniCAD Sample


HRESULT GetEntityCount(int *pnCount)

Parameters

pnCount - [out] pointer to an integer variable which will receive the number of objects in the model.

Returns

S_OK in case of success.

Remarks:

The method returns number of top-level objects (entities) in the model.


HRESULT GetEntity(int index, ISection **ppIEntity)

Parameters

index - [in] zero-based index of the object.

ppIEntity - [out] returned pointer to the interface. 

Return Values

S_OK in case of success.
DISP_E_BADINDEX - if index is greater than or equal to the number of objects in the model
 
Remarks:
 
Returns pointer to ISection Interface of the index--th top-level object in the model. Each interface obtained with a call to this method must be released with a call to Release() method of the obtained interface, when it is no longer needed.

HRESULT Save(char* szFilePath)

Parameters

szFilePath -[in] path of the model file.

Return Values

S_OK in case of success. 
DISP_E_PARAMNOTOPTIONAL - if szFilePath is NULL. 
ERROR_FILE_NOT_FOUND - if there was a failure during saving the file.  
 
Remarks
 
Returns pointer to ISection Interface of the index-th object in the model. Call Release() on the obtained interface when you have finished to use it.

HRESULT Update()

Return Values

S_OK in case of success.

DI_E_INVALIDGEOMETRY - In case the most recent changes where not accepted because they make the geometry of the model invalid. definition of DI_E_INVALIDGEOMETRY can be found in file DIError.h of Samples\Include folder of the installation directory.

Remarks:

This method is equivalent to UpdateSurface of the DG Kernel control with the exception that it does not redraw the control's window automatically. To redraw the window, some method of the particular environment like System.Windows.Forms.Control.Update in .NET or CWnd::Invalidate() and CWnd::UpdateWindow() in MFC has to be called. See MiniCAD sample

The method recalculates the surface of the model after any changes to parameters of the model. This method or UpdateSurface above has to be called after a sequence or a single modification of the models parameters, which affect shape of the object. Most commonly it is done after  call(s)  to one of SetParam methods of IElement or IElem interface. In contrast, for example, object movements with I3DObject do not change internal geometry of the object, so the Update method does not have to be called.

A valid sequence of modifications should involve only one modification per parameter. Before making another modification to the same geometrical parameter Update or UpdateSurface has to be called. For example 

    iElemPoint.SetParam(0, 0.5);
    iElemPoint.SetParam(1, 0.9);
    iModel.Update();

is a valid sequence, but 

    iElemPoint.SetParam(0, 0.5);
    iElemPoint.SetParam(0, 0.9);
    iModel.Update();

is not.

Note that this method is costly in terms of computational load, so it is recommended to call it once per logically complete sequence of user input.


HRESULT GetModelPath(string *path)

Parameters

szFilePath - [in] path of the model file.

Return Values

S_OK in case of success. 

Remarks

Returns full resolved model path. This method is particularly useful when the ModelPath property of the DG Kernel component is either not full or has special prefixes

See Cloud sample for an example

HRESULT GetItemCount(int* count)

Returns count of top-level non-geometric scene items, which are not entities, i.e. which implement IItem, but not ISection interface


HRESULT GetItem(int index, IItem** iItem)

Returns index-th top-level scene item.