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


IStdShape Interface

Cylinder
Disk
Sphere
Box
Torus
Triangle
Polygon
Line
Circle
Rectangle
LineInf
EEllipse

IStdShape interface provides a simplified method for creation of standard objects.

There are two implementations of IStdShape in DG Kernel. They create different types of objects. The first one creates objects as 3DS, SOR and LineEntitys. This IStdShape can be queried from IModel interface. To obtain the other one query IPropertyArray from IModel, call IPropertyArray.GetProperty("IKO_Model") and cast (query) the returned object to IStdShape. IStdShape queried via this path creates all objects as B-Spline surfaces or curves.

See ObjectArray sample or NewStandardObjectForm.cs of the Model  Explorer's source code for an example

 All methods create an object at the global origin and add it to the model as the last top-level object. The returned IIEntity interface can be used to modify location, orientation, shape and other properties of the object. Use IFrame2, IFrame or I3DObject queried from the returned ISection to move the object in 3D space.

To create a standalone object without adding it to the model call a relevant method, assign the returned ISection reference to a variable or member to keep the entity alive and remove the last object top-level object from the model this IStdShape was queried from using IArray interface.

See also: Object Array Sample, Dynamic Object Creation, Interface List


HRESULT Cylinder(double baseRadius, double topRadius, double height, ISection** cylinder)

Parameters

baseRadius - [in] Radius of the cylinder at z = 0 plane

topRadius - [in] Radius of the cylinder at the top

height- [in] Height of the cylinder along its axis (z-axis)

obj - [out] ISection interface implemented by the created object.

Remarks:

The method creates a cylindrical surface around z-axis of the global frame and adds it to the model Depending on parameters the surface can be cylinder, cone or truncated cone. The created object has SOR type, which has generatrix strip containing a single line.


HRESULT Disk(double innerRadius, double outerRadius, ISection** disk)

Parameters

innerRadius - [in] Radius of the inner circle

outerRadius - [in] Radius of the outer edge

obj - [out] ISection interface implemented by the created object.

Remarks:

The method creates a two-dimensional disk in x any y plane of global axes with center at the origin. The disk has an internal hole of radius innerRadius, which can be removed by setting innerRadius to 0. The created object has SOR type, which has generatrix strip containing a single point.


HRESULT Sphere(double radius, ISection** sphere)

Parameters

radius - [in] Radius of the sphere

obj - [out] ISection interface implemented by the created object.

Return Values

S_OK in case of success.
Remarks:

The method creates a sphere with center at the origin. The created object has SOR type, which has generatrix strip containing a single arc.


HRESULT Box(double width, double height, double length, ISection** box)

Parameters

width - [in] x-dimension of the box

height - [in] y-dimension of the box

length - [in] z-dimension of the box

obj - [out] ISection interface implemented by the created object.

Return Values

S_OK in case of success.
Remarks:

The method creates new box aligned with the global axes. Two opposite corners of the box are: the origin (0, 0, 0) and (width, height, length). The created object has 3DS type.


HRESULT Torus(double radius, double radiusTube, ISection** torus)

Parameters

radius - [in] Radius of the circular axis of the tube

radiusTube - [in] Radius of the tube

obj - [out] ISection interface implemented by the created object.

Return Values

S_OK in case of success.
Remarks:

The method creates a torus with center at the origin. The circular axis of the tube lies in the x and y plane of the global axes. The created object has SOR type.


HRESULT Triangle(DIPoint* pt0, DIPoint* pt1, DIPoint* pt2, ISection** obj)

Parameters

pt0,pt1,pt2 - [in] corners of the triangle

obj - [out] ISection interface implemented by the created object.

Return Values

S_OK in case of success.
Remarks:

The method creates a triangle in 3D space. Coordinates of the input points are relative to the global axes, which will coincide with the local frame. The created object has Mesh Entity type.


HRESULT Polygon(DIPoint* pt0, DIPoint* pt1, DIPoint* pt2, DIPoint* pt3, ISection** obj)

Parameters

pt0,pt1,pt2,pt3 - [in] vertices of the polygon.

obj - [out] ISection interface implemented by the created object.

Return Values

S_OK in case of success.
Remarks:

The method creates a filled polygon built on the supplied 3D points, rectangle is one of shapes which can be created. The created object has Mesh Entity type.


HRESULT Line(DIPoint* pt0, DIPoint* pt1, ISection** obj)

Parameters

pt0,pt1 - [in] Ends of the line.

obj - [out] ISection interface implemented by the created object.

Return Values

S_OK in case of success.
Remarks:

The method creates a line connecting the points. The created object has Line Strip type.


HRESULT Circle(double radius, ISection** obj)

Parameters

radius - [in] Radius of the circle

obj - [out] ISection interface implemented by the created object.

Return Values

S_OK in case of success.
 
Remarks:

The method creates a circle in the x and y plane of the global axes and center at the origin. The created object has SOR type, which has generatrix strip containing a single point.


HRESULT Rectangle(double width, double height, ISection*** obj)

Parameters

width, height - [in] Dimensions of the rectangle

obj - [out] ISection interface implemented by the created object.

Remarks:

The method creates a rectangle in the x and y plane of the global axes and center at the origin.


HRESULT LineInf(DIPoint* origin, DIVect* direction, VARIANT_BOOL ray, ISection** obj)

Parameters

origin - [in] A point on the line

direction - [in] Direction of the line

ray - [in] Sepcifies whether the object is a ray or an infinite both ways line

obj - [out] ISection interface implemented by the created object.

Remarks:

The method creates a ray or an infinite both ways straight line


HRESULT Ellipse(double a, double b, ISection** obj)

Parameters

a - [in] The first radius of the ellipse

b - [in] The second radius of the ellipse

obj - [out] ISection interface implemented by the created object.

Remarks:

The method creates an ellipse in the x and y plane of the global axes and center at the origin. The created object has CurveGeometry type and cam be moved in 3D with I3DObject, IFrame, etc interfaces