KernelCAD Documentation

DInsight Home
Skip Navigation Links.
Start page
Quick Start
Installation
Overview of the software
What is new
Collapse KernelCAD ModelsKernelCAD Models
Model Structure
Securing Models
Collapse Import/ExportImport/Export
Import and Export
Collapse Adanced Data ExchangeAdanced Data Exchange
Data Flow Sample
STL Tree
IDataContext Interface
ISTLDataContext Interface
Collapse Scene ItemsScene Items
Items
3D Text
Smart Labels
View Points
Collapse MeasurementsMeasurements
Measurements
Persistent Measurements
Grid
Collapse SectionsSections
Sections
Section Types
Collapse 2D2D
Overlays
2D Models
2D Items
Point Sets
Collapse Line and Curve SectionsLine and Curve Sections
Line Strips
Line Section
3DS Curves
Collapse Surface and Solid SectionsSurface and Solid Sections
Surfaces
Collapse Mesh SectionsMesh Sections
Mesh Section
Mesh
Surface Of Revolution
BRep 3D Objects
Collapse BRep BSpline objectsBRep BSpline objects
Bspline objects
BSpline Faces
BRep Section
Pipes
Collapse 3DS Sections3DS Sections
3D Section
Profiles
Surface Patches
Surfaces and Patch Strips
Collapse AttributesAttributes
Material
Clipping Planes
Symmetries (Arrays)
Textures
Collapse OperationsOperations
Boolean Operations
Surface Trim
Cut Surface
Collapse MovementsMovements
Movements
Kinematic Sections
Collision Detection
3D Grid
Collapse Mathematical ObjectsMathematical Objects
Pure Geometric Objects
Points and Vectors
Planes
Collapse CurvesCurves
Straight Lines
3D Circle
Ellipse
Free-Form Curves
Arc Spline Curves
Frames
Transfroms
Oriented Boxes
Collapse 2D Elements2D Elements
Geometric Elements
Arcs
Line Strips
Collapse Basics of 3D GraphicsBasics of 3D Graphics
Concepts
3D View
2D View
Viewing Volume
Birds Eye View
Viewing Plane
Perspective View
Background
Collapse AlgorithmsAlgorithms
Euclidean Shortest Path
Collapse User DataUser Data
Layers
Object User Data
Model User Data
Collapse KernelCAD ComponentsKernelCAD Components
KernelCAD Control
KernelCAD .NET Control
Methods and Properties
Menu
Model Explorer
Birds Eye View
Programming
Direct User Access
Direct Operations
Interface Queries
Printing Support
Data Types
Modes of KernelCAD Control
DIObjectGenerator class
Properties
FlatObjectArray Poperty
Context
64 bit development
Dual Mode
Initialisation Context
Overlay Editor
Memory Management
Input validation
Collapse Advanced functionalityAdvanced functionality
Topological Modifications
Programming commands
Dynamic model restructuring
Dynamic Object Creation
Generator of 3D Sections
Generator of SOR Objects
Model class
Selection
Selection Event
External Models
Collapse InterfacesInterfaces
Alphabetical list
I3DGrid
I3DBugger
I3Dpt
IAxiBase
IAxis
IBoolSection
IBoolSectionEx
IBoundary
IColor
IConstraint
IData
IDiffSurface_KC
IDIFont
IDraw
IDrawUtil
IDraw2
IElem
IElement
IKCLine
ILightSource
ILocation
ILocationEx
IMaterial
IMetrics
IMetrics2
IModel
IModel2
IModelEx
IPatch
IKCPathCollisionDetector
IProfiles
IPropertyArray
IPropertyArray2
IStdShape
IStrip
ISurface
IText
ITexture
ITransform
IUnknown
Collapse Open Cascade TechnologyOpen Cascade Technology
IKO_Standard_Object
IKO_Model
IKO_TopExp_Explorer
Collapse BRepExtremaBRepExtrema
IKO_BRepExtrema_DistShapeShape
Collapse Geom2dGeom2d
IKO_Geom_CylindricalSurface
IKO_Geom_ElementarySurface
IKO_Geom2d_Circle
IKO_Geom2d_Conic
IKO_Geom2d_Curve
IKO_Geom2d_Geometry
IKO_Geom2d_Line
Collapse GeomGeom
IKO_Geom_BSplineCurve
IKO_Geom_BSplineSurface
Collapse GPGP
IKO_gp_Ax1
IKO_gp_Ax2
IKO_gp_Ax22d
IKO_gp_Ax2d
IKO_gp_Ax3
IKO_gp_Circ2d
IKO_gp_GTrsf2d
IKO_gp_Lin2d
IKO_gp_Mat2d
IKO_gp_Object
IKO_gp_Sphere
IKO_gp_Cone
IKO_gp_Torus
IKO_gp_Trsf
IKO_gp_Cylinder
IKO_gp_Pln
IKO_gp_Circ
IKO_gp_Trsf2d
Collapse GeomAPIGeomAPI
IKO_GeomAPI_PointsToBSpline
IKO_GeomAPI_Interpolate
Collapse TColStdTColStd
IKO_TColStd_Array1
IKO_TColStd_Array1OfInteger
Collapse TColgpTColgp
IKO_TColgp_Array1OfPnt
IKO_TColgp_Array1OfVec
Collapse BRepBRep
IKO_BRep_Builder
Collapse BRepBuilderAPIBRepBuilderAPI
IKO_BRep_Builder
IKO_BRepBuilderAPI_MakeWire
IKO_BRepBuilderAPI_MakeEdge
Collapse BRepOffsetAPIBRepOffsetAPI
IKO_BRepOffsetAPI_ThruSections
Collapse BRepPrimAPIBRepPrimAPI
IKO_BRepPrimAPI_MakePrism
Collapse ModModelingAlgorithmsModModelingAlgorithms
IKO_BRepGProp_Face
Collapse TopoDSTopoDS
IKO_TopoDS_Shape
IKO_TopoDS_Edge
IKO_TopoDS_Face
IKO_TopoDS_Wire
Collapse DataData
Collapse Import / ExportImport / Export
IDataConvert_KC
ICADFormat_KC
IDataContext
ISTLDataContext
IFormatVersionDataContext
Collapse User Data User Data
ILayers
IDataSource
IDataTable
IRecordSet
IDataMods
IUserData
IMatrixData
Collapse MovementMovement
IKinematicSection_KC
IMove_KC
IKinematicSet_KC
ICutEffect_KC
ISpinEffect_KC
Collapse FramesFrames
I3DObject
IFrame
IFrame2
IFrame3
IFrameEx
Collapse Oriented ObjectsOriented Objects
IObjectOriented
ISphere_KC
IBox
Collapse SectionsSections
Collapse ItemsItems
IItem
ILabel3D_KC
IDynamicScreenItem_KC
IDynamicScreenItemManager_KC
ISmartLabelManager_KC
ISection
ISection2
ISectionPointSet
ISectionLineStrip
ITextSection_KC
IPipeSection
ILineSection_KC
IObjectPosition_KC
ISticky_KC
ILabelSection_KC
IModelHealer_KC
IPointCloud_KC
IProfiledElement_KC
Collapse Mesh interfacesMesh interfaces
IMesh
IMeshTopol
ISimplex
IMeshMods
IVertex
IMeshEx
IIterator
IMeshPointKC
ISurfacePointKC
ISurfaceMetric_KC
IVertexEx_KC
IEdge_KC
ISimplexEx_KC
IMeshAlgor
IMeshShading_KC
Collapse GeneralGeneral
Collapse Collections InterfacesCollections Interfaces
IArray
IArray2
IList
IListUnkn_KC
IRelation
IArrayNum
IArray3D
IRefMap_KC
IObject_KC
ITypeBasic_KC2
IModelSearch_KC
IBitmap
IBlob
IKCContext
IKCContext2
IError_KC
IKCStack
ILineStyle_KC
IMenu_KC
IMenuItem_KC
IGlobalAPI_KC
IControlInitialisationContext_KC
IRange
IRectangleAxisAligned_KC
Collapse Topological InterfacesTopological Interfaces
IStripTopol
I3DSectionGenerator
ISORSectionGenerator 
IDIObjGenerator
Collapse Viewing InterfacesViewing Interfaces
IView
IView2
IViewPoint
IViewPointArray
ILookAt
IViewModal
ILook
ILookEx
IMeasurement_KC
IPick
ISelection_KC
IRectangleColor_KC
I2DView_KC
I2DView2_KC
I2DEditor_KC
IPrint_KC
IVirtualView
IGraphicItem
Collapse Lines And CurvesLines And Curves
ILine
ILineGeom
ILineMetr
ICurve
ICurveFreeForm
ICurveFreeFormEx
IArcSpline3DCurve
IArc
IArcEx
ICircle3D_KC2
IEllipse_KC
Collapse Symmetry InterfacesSymmetry Interfaces
ISymmetries
ISymmetry
IAxialSymmetry
Collapse Clipping plane interfacesClipping plane interfaces
IClipArray
IClipPlane
Collapse AlgorithmsAlgorithms
IEuclideanShortestPath_KC
Collapse 2D Geometry2D Geometry
ILine2D
IArc
IArcEx
IStripArcLine_KC
Collapse Programming Samples and TutorialsProgramming Samples and Tutorials
Collapse OverviewOverview
Sample List
3DBugger
BoolOp
PlanarOps
Calculator
Capture
Cannon
Clip
Cloud
Collision
Collision Path
Cross View
Data Flow
Data Flow
Deploy Tutorial
DiffSurface
Direct User Access Demo
DIView
eMotion
Euclidean Shortest Path
Gear
Label
LabelEx
Layers
Light
Lines
LowDim
Make Your Move
Measure
Mesh Mods
MeshOps
Metrics
MiniCAD
Modal
Modeling Curves
Morph
Object Array
Overlay
Patch
Patchwork
Pick
Point Of View
BoolOp
Profile
Rotation
Pipes
Layers
Shape Explorer
Smart Labels
Strip Topology
Surface Metrics
Symmetry
Transform
Texture
Turbine
TwoD
User Data
View Point
WpfCAD
Zoom
Collapse DeploymentDeployment
Deploy Tutorial
DeployModule
DeployWixBasic
WixDeploy
Collapse .NET Samples.NET Samples
Collapse C# SamplesC# Samples
Patch Tutorial
MiniCAD Sample
Strip Topology Sample
DI View Sample
Modal View Sample
Modeling Curves
Label
LabelEx
Pick
Object Array
Data Flow
Profile
Cross View
Low Dim
Morph
Clip
BoolOp
Collision
Collision Path
3DBugger
Data Flow
Shape Explorer
Smart Labels
Symmetry Sample
Cannon
View Point Sample
Capture
User Data
Layers
Zoom
Collapse Visual Basic SamplesVisual Basic Samples
Patch Tutorial
DI View Sample
MiniCAD Sample
Object Array Sample
BoolOp
Data Flow
Pipes
Transform
Measure
Mesh Mods
Mesh Ops
Metrics
Morph
TwoD
eMotion
Cross View
3DBugger Tutorial
Collision
Collision Path
Light
Patchwork
Capture
Collapse WPFWPF
Clip
Mesh Ops
Measure
Lines
LowDim
WPF
Patch
Collapse Delphi SamplesDelphi Samples
3DBugger
BoolOp
Calculator
Patch Sample
Modelling Curves
MiniCAD Sample
Morph
Shape Explorer
Object Array
Metrics
Cannon
Pipes
Patchwork
Collision
Collapse C++ SamplesC++ Samples
3DBugger
BoolOp
Cannon
Capture
Cloud
Collision
Collision Path
Cross View
DI View Sample
eMotion
Gear Sample
Label
LabelEx
Light Sample
Measure
Mesh Ops
MiniCAD Sample
Modal Sample
Modeling Curves
Object Array Sample
Overlay Sample
Patch Tutorial
Pick
Point Of View
Planar Ops
Rotation Sample
Profile Sample
Shape Explorer
Smart Labels
Strip Topology Sample
Layers
Lines
LowDim
Metrics
Metrics2
Morph Sample
Patchwork
Pipes
Symmetry Sample
Texture Sample
Transform
TwoD
Turbine Sample
User Data
View Point Sample
Zoom Sample
Collapse Visual Basic SamplesVisual Basic Samples
Patch
DI View
MiniCAD
Data Flow
Cross View
Cloud
Planar Ops
Calculator
Light
Pick
Object Array
Label
Symmetry
Transform
Morph
Line Strip
Capture
Collapse Delphi SamplesDelphi Samples
KernelCAD and Delphi
3DBugger
Data Flow
BoolOp
Calculator
Cannon
Collision
Label
LabelEx
Metrics
MiniCAD
ModelingCurves
Object Array
Patch
Patchwork
Pipes
Collapse 3D Debugger3D Debugger
Creating and editing models
Editing Generic 3D Objects
Topological Commands
Model Explorer
Export / Import
Modeling Tips
3D Debugger
Collapse EditorsEditors
Form View
3D View
Collapse 2D Editors2D Editors
Crossection View
Profile View
Drum View
Collapse DialogsDialogs
3D Curve Dialog
Symmetry Collection Editor
Clip Editor
Material Editor
Surface options dialog
Collapse Modelling TutorialsModelling Tutorials
Table Tutorial
Mouse Tutorial
Collapse DeploymentDeployment
Redistribution
Registration
Deploy Module Tutorial
WixDeploy Tutorial
DeployWixBasic
Deploy Tutorial
Licensing
Model Viewer
Open C++ Source
Technical Support
Skip Navigation LinksHome Page > KernelCAD Components > Interfaces > IMetrics
IMetrics Interface

IMetrics(64) Interface

Dist
GetDimensions
GetPointLocation
IsCloserThan

This interface obtains the size of the model. Warning: IMetrics can be expanded (but not changed) in future releases.

IMetrics can be queried from IModel, ISection and possibly other obejcts in intermediate updaes and releases. Attemp to query this interface from an object to check if the obekct implements th einterface.

When queried from IModel this interface goves results related to the whole set of objects. For example GetDimentions() method returns bounding box of the whole model.

See also: Metrics Sample/a>, Collision detection, Collision Sample, Interface List


HRESULT Dist( IMetrics * iIMetricObj, MetrDistContext* context, IRelation** nearest, double* dist )

Parameters

iIMetricObj - [in] IMetrics interface implemented by the second object. See remarks.

context - [in] NULL reference or MetrDistContext structure containing additional parameters. When the reference is NULL all defaults are used. See remarks.

nearest - [out] If nearest is not a NULL reference, a IRelation will be retuned in the referred variable. Lists referred to by the relation nearest keep elements of type IVertex. See remarks.

dist - [out] Returned distance between the objects

Remarks:

See also IMetrics2.Dist for a simplified version of this method.

The method calculates the distance between the object implementing the interface and the object where iIMetricObj  was queried from. Distance is the shortest distance between any two points belonging to the objects.

The returned nearest interface can be used to investigate set of pairs of mutually nearest points from the two objects.

The size of the set depends on options supplied in the context structure. In the simplest (default) case if context .needAll = false the set consists of a single pair of two nearest points. When there are more than one nearest pair at exactly the same distance, selection of the returned pair is random.

When context.needAll is set to true  and d is the minimal distance retuned by the method the set will contain all pairs at distances in range d to d+context.tolerance. Note that when there are infinite numbers of nearest points, like in the case of parallel planes, only a finite number of distinct ones are selected. This selection depends on the geometry of mesh of the surface.

includeChildren member of context is true children of both objects are considered as part of the object.

To obtain information about particular point, call IRelation.GetRelation method of the nearest interface to obtain list of all pairs. Browse the list using its IIterator interface. Retrieve the required pair with a call to IList.GetAt of the list of pairs and cast it to AssociationPair type. Use the obtained posn0 position to obtain IVertex interface from the first list of the nearest relation. The first list is returned from call to IRelation.GetItemList(true) of the nearest IRelation interface. It contains elements of type IVertex. IVertex interface can be used to obtain information about coordinates as well as normal(s) to the surface at the point.

Elements of the pair list are sorted by increasing distance. The nearest two points are listed first. The order is random for pairs at exactly the same distance.

Note 1: that this method is computationally intensive for large models. It is recommended to avoid calling it in a tight loop with context.needAll and/or context.includeChildren set to true. Consider using the IsCloserThan method in this situation instead.

Note 2: The algorithm assumes that the objects do not have internal intersection, i.e. they do not have common points which belong to strictly internal area of both objects. If this happens the algorithm may return incorrectly small positive number.


HRESULT GetDimensions( DIPoint* min, DIPoint* max )

Parameters

min - [out] 3D point in global coordinates (See DIPoint). Coordinates of min a are minimal values of the coordinate for any point in the model.

max - [out] 3D point in global coordinates (See DIPoint). Coordinates of max a are maximal values of the coordinate for any point in the model

Return Values

S_OK in case of success.
Remarks:

This method returns opposite diagonal corners of the minimal box totally containing the model.


HRESULT GetPointLocation( DIPoint* pt, int* location )

Parameters

pt - [in] point location of which is to be found  Coordinates must be relative to the local frame of the box if the box is oriented or global is the box does not have a local frame

location - [out, retval] The returned location code. See remarks

Remarks:

Identifies location of the point. The object where this interface was queried from is assumed to be solid (has closed surface). Meaning of the returned location code depends on type of the object, which implements the interface.

In this release this method implemented only by Mesh Sections and Oriented Boxes.

Mesh Sections

pt must have global coordinates. Return codes:

  • -1  - Invalid location (error code)
  • 0  - inside internal area of the solid, not on the surface
  • 1  - Outside not on the surface
  • 2  - Coincides with a vertex
  • 3  - Lies on an edge of the mesh
  • 4  - Inside a face of the mesh

Notice that codes greater than 1 indicate that point lies on the surface.

Oriented Boxes

Coordinates of pt must be relative to the local frame of the box if the box is oriented or global is the box does not have a local frame. See Location codes for boxes for the return codes.


HRESULT IsCloserThan( IMetrics * iIMetricObj, double dist, MetrIsCloserThanContext* context, VARIANT_BOOL* closer );

Parameters

iIMetricObj - [in] IMetrics interface implemented by the second object. See remarks.

dist - [in] Value to compare the distance to.

context - [in] NULL reference or MetrIsCloserThanContext structure containing additional parameters. When the reference is NULL all defaults are used. See remarks.

closer - [out] The returned Boolean value. True if the objects have points closer than dist and false otherwise.

Remarks:

The method returns true if the distance between object implementing the interface and the object where iIMetricObj  was queried from is less than dist.

If includeChildren member of context is true children of both objects are considered as part of the object. . Default: false

If further member of context is true the method will solve the opposite problem: Return true if there are two points in the objects, which are have distance greater than dist. Default is false

quickCheck member of the context structure allows significant acceleration of the algorithm when two object are either convex or at distance greater than maximal distance between any two adjacent vertexes of the mesh. Set it to false is not sure. It should be true if it is expected that some straight line between any two points of one object can intersect with another object.

This method is supplied as alternative to Dist method for applications like collision detection. In most cases it offers better performance. For collision detection it is recommended to use calls to this method between changes in the object(s) position or orientation. If needed, once the method returns false (collision) the Dist method can be called to retrieve information about the nearest points.

Note: The algorithm assumes that the objects do not have internal intersection, i.e. they do not have common points which belong to strictly internal area of both objects.

See also: Collision detection, Collision Sample