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


IViewModal Interface

SetViewMode
GetViewMode
SetCurrentFrame
GetCurrentFrame
SetAutoMode
GetAutoMode
ResetAutoMode

IViewModal interface allows switching between two "View" and "Modify" modes of the view, which implements this interface. See Modes topic for more details. Modes are different with respect to how user mouse moves are processed. "View" is the default mode. In View mode mouse moves allow changing point of view by Pan/Zoom/Rotate viewing transformations. In "Modify"  mode mouse moves change position or orientation of the current object in the model. In modify mode, similar to viewing transformations, mouse moves with Shift key down will perform translations of the object. If Shift key is not down rotations of the object will be performed. IViewModal can be queried from IView interface.

See also Modal sample, Interface List


HRESULT SetViewMode( int nMode )

Parameters

nMode  - [in] new mode type. Valid modes are 1 and 2. if nMode = 1 the current mode will be set to "View". if nMode = 2 the current mode will be set to "Modify". See remarks below.

Returns

S_OK in case of success.

DISP_E_PARAMNOTOPTIONAL - when nMode is not one of valid values 1 or 2.

Remarks:

This method allows switching between two available modes. Modes are different with respect to how user mouse moves are processed. "View" is the default mode. In View mode mouse moves allow changing point of view by Pan/Zoom/Rotate viewing transformations. In "Modify"  mode mouse moves change position or orientation of the  current object in the model. In modify mode, similar to viewing transformations, mouse moves with Shift key down will perform translations of the object. If Shift key is not down rotations of the object will be performed. 

For C++ code file DInsight\Samples\VC\Include\DIInterface.h contains definitions for valid values of nMode. 

VB, .NET and similar IDEs can use cast of EDIMove enumeration type to refer to available modes symbolically.


HRESULT GetViewMode( int * pnMode )

Parameters

pnMode [out, retval] reference to an integer variable, which will receive the current mode of the view.

Remarks:
 
The method returns the current mode. See also  remarks for SetViewMode method.

HRESULT SetCurrentFrame( IFrame *pIFrame )

Parameters

pIFrame -  [in] reference to the frame, which will be set current for manipulations in "Modify" mode. See Remarks. pIFrame can be NULL (value zero). In this case the view will not have a current frame. See also IFrame interface

Return Values

DISP_E_PARAMNOTOPTIONAL - when pIFrame is not a frame obtained from  ISection of an object in the model.

Remarks:
 
The method allows setting which object (among all present in the model) will be set as current for modifications by mouse movements in "Modify" mode (See SetViewMode method.). pIFrame reference is normally obtained from the correspondent ISection interface by queering or coercing.
 

HRESULT GetCurrentFrame( IFrame **ppIFrame )

Parameters

ppIFrame [out, retval] reference to IFrame pointer, which  will receive the pointer to the current frame in the view. This variable will be set to NULL if there is no  current object in the model.

Remarks:
 
The method returns IFrame interface implemented by the current object.. The method will return NULL if there is no current object in the model.

HRESULT SetAutoMode(int mode)

Parameters

mode [in] The mode which will be set as auto. See remarks

Remarks:
Selects mode as auto mode. mode must be one of values described in SetViewMode above. Auto mode affects behaviour after manipulations of view with mouse clicks or strokes. The auto mode will be set automatically inside left mouse button up event handler. Mostly often mode should be set to "View". In that case when application sets the mode to "Modify", the "View" mode will be reset automatically after the user selected or moved an object with the mouse.

HRESULT GetAutoMode(int* mode)

Parameters

mode [out, retval] The mode currently selected as auto mode


HRESULT ResetAutoMode()

Remarks:
 
Removes auto mode selection. After that call the current mode will be changed only on SetViewMode unless SetAutoMode is called again