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


IFrame Interface

RotateStd
SetAxes
Reset

Methods inherited from I3DObject:

GetOrigin
SetOrigin
GetAxis
Translate
Rotate

IFrame interface is used only to control orientation and position of different frames in the DInsight software. A frame is actually a local system of coordinates. It is uniquely determined by 3D point of its origin in global coordinates and 3D vectors of its axes. To be valid, vectors of the axes must have length 1.0 and be orthogonal to each other.  IFrame interface is inherited from and hence has all methods of I3DObject interface. Additional methods allow more flexibility in manipulation of the frame.

Currently IFrame is can be queried only either from IView or ISection interface. In case of IView IFrame represents current position of the global frame with respect to the point of view. More precisely IFrame controls coordinates of the global frame relative to the Eye Frame. When IFrame is queried from ISection it acts as an extension of I3DObject and exposes position and orientation of the object in 3D space.

To create a new (standalone) frame to for some calculations call IDIObjGenerator.Create or IDIObjGenerator.Create2 with eType parameter set to eObjTypeFrame member of EObjectType enumeration. The returned IUnknown reference has actual type IFrame and can be safely cast to or queried from to convert to IFrame type.

See also Modal View Sample, Interface List


HRESULT RotateStd(double dAng, int nAxis)

Parameters

dAng - [in] Angle of rotation in degrees .

nAxis - [in] 0-based index of the axis around which the rotation will be performed 

Returns

S_OK in case of success.

Remarks

Changes orientation of the frame by rotating it around its specified axis


HRESULT SetAxes(int nAxis0, DIVect* axis0, int nAxis1, DIVect* axis1, bool bOrientation)

Parameters:

nAxis0 - [in] 0-based index of axis, which will be changed to axis0. 

axis0 - [in] 3D vector which will be set as nAxis0-th axis of the frame. DIVect type is described in Basic Types

nAxis1 - [in] 0-based index of axis, which will be changed to axis1. 

axis1 - [in] 3D vector which will be set as nAxis1-th axis of the frame. DIVect type is described in Basic Types. Supplying zero vector for this parameter means the axis is not specified. The method will select an arbitrary orthogonal axis.

bOrientation - [in] normally is true. If bOrientation is true the resulting axes will have normal positive orientation like standard Cartesian system of coordinates. Otherwise direction of the remaining axis will be changed to opposite in the end of the method call (See remarks).

Returns

S_OK in case of success.
DISP_E_PARAMNOTOPTIONAL in case axis0 or axis1 are zero vectors or have the same direction
 
Remarks
This methods is provided for the case when simpler RotateStd method is not satisfactory. Call this method to set directions of axes of the frame. DIVect type is described in Basic Types. Normally axis0 and axis1 are orthogonal vectors. They must not have the same direction otherwise the method will fail with DISP_E_PARAMNOTOPTIONAL return code. If axis0 and axis1 are not orthogonal orthogonalization is applied to axis1. Supplying zero vector for axis1 parameter means the axis is not specified. The method will select an arbitrary orthogonal axis. In addition to that, both vectors are normalized to make their lengths equal to 1.0. The third remaining axis is calculated using the supplied ones and condition that it must be orthogonal to both of them and have its length equal to 1.0.
 
bOrientation is normally is true. In this case the resulting axes will have normal positive orientation like standard Cartesian system of coordinates. Otherwise direction of the remaining axis will be changed to opposite in the end of the method call.


HRESULT Reset()

Return Values

S_OK in case of success
Remarks
Resets the frame to its default: After this call the frame will coincide with the global frame .