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 Models > Scene Items > 3D Text
3D Labels

3D Text (Labels)

3D Label is a text string displayed in 3D View of KernelCAD components. 3D Labels are part of the model, hence they are stored and loaded from the model files. Similar to objects 3D Labels have 3D location, Visibility, Name and Parent properties. In addition to that 3D Labels possess modifiable font (size, face name and color) property.

Facing Labels

Facing Labels are always oriented in plane parallel to the plane of the screen (to the viewing plane).

Labels are Localized Items. Like objects, 3D Labels can belong directly to the model (top-level labels) or be a child of an object. 3D Labels can not have children. For top-level labels the Parent property (IItem.GetParent) is NULL.

Labels can be positioned statically at a 3D model location or at a fixed screen location. It also can be set to appear always on top of an object or above all object in the model.

To add  new 3D Label in 3D Debugger select "New Object" in Model menu. Select Label under Accessories node. Press Modify button to change text and properties. Turn on "Make child of current object" to attach label to the current section or leave it unchecked to make it a top-level label.

To modify properties of a label in 3D Debugger open Model Explorer, select the label in the tree view and press Edit button on the right hand side.

Labels can be joined to an object or detached from an object using Action menu of the Model Explorer

Programming Facing Labels

To create a new 3D facing label query IPropertyArray2 from IModel. Call IPropertyArray2.GetProperty("Items"). Cast (query) the returned object to IArray2. Call IArray2.InsertNew( eItemTypeLabel, -1 ) to add the label.

To obtain access to a particular label object query IItem implemented by the label as described below. IItem controls visibility of the label and its relation to all other items and objects. All other properties of the label are controlled by ILocation, ILocationEx, IText and IDIFont queried from the IItem.

IItem implemented by a top-level 3D Label can be obtained via:

Query path: KernelCAD >GetModel > IModel > IPropertyArray2 > GetProperty("ItemArray") > IArray2 > GetAt > IText

IItem implemented by a 3D Label attached to an object can be obtained via:

Query path: ISection > IPropertyArray2 > GetProperty("ItemArray") > IArray2 > GetAt > IText, where ISection represents the object.

Labels aligned to the Eye Frame (i.e. screen, details) can have a rectangle drawn around the text. Use ILabel3D_KC queried from IItem  or IText to enable this property.

See Label and LabelEx programming examples.

Smart Labels

Smart Labels are a special (managed) type of facing labels. They are arranged automatically on the screen so they do not overlap and positioned close to the object they are associated with. Details.

Geometric Text

Geometric Text is a text string implemented as a geometric shape arbitrary located and oriented in 3D. It has all usual properties of a 3D section like position, orientation, material color, name etc accessible via ISection and many other interfaces.

The text can be created programmatically or using LabelEx Sample. Query IDIObjGenerator from IModel. Call IDIObjGenerator.Create3("TextSection_KC"). Cast (query) the returned object to ITextSection_KC type. Use ITextSection_KC.CreateGeometry*() to construct geometry of the text object. Query I3DObject, IFrame*, ISection, etc to modify location, color and other properties of the object

In the intial release it is recommended to delete the object and recreate it again if modifications of the text string, font or other properties defined in ITextSection_KC.CreateGeometry*() parameters are needed.

Engraving or welding text

As characters of text created with ITextSection_KC.CreateGeometrySolid are solid objects they can be used for Boolean Operations so the text can either be engraved (etched) or welded into a surface. Boolean operations on groups of objects are useful for that. For example to engrave a string on a cylinder execute Boolean Subtract using IBoolSectionEx.Execute3() with the cylinder as the first object and ISection queried from the text section (from ITextSection_KC) as the second. The IncludeChildrenOther parameter of the context should be true. This way all letters will be subtracted in one call despite the parent section is an empty object because it is acting rather as a group.

Make few experiments with very short strings first as the operation can be very slow. If the operation fails try increasing size of the characters, select simpler font (Arial), position text so there are no tangetial surfaces and well defined intersectino line with each letter.

See LabelEx sample for an example

Sticky Labels

Sticky Labels can be rendered inside a rectangle arbitrary positioned and oriented in 3D or applied (attached/stuck) to a surface of an object. These two states are called Attached state.

Sticky Labels can be created programmaticaly at runtime using call similar to:

IItem iItem = (IItem)iModel2.AddNewItem(EObjectType.eObjTypeLabelSection);

where iModel2 is an IModel2 interface or using IDIObjGenerator.Create*(EObjectType.eObjTypeLabelSection) call. The object is a section so it implements ISection*, IFrame* and other releated interfaces and can be positioned and oriented arbitrary in 3D space.

Query ILabelSection_KC from iItem to access properties of the label. Use ILabelSection_KC.GetText() and ILabelSection_KC.GetFont() to obtain  IText and IDIFont to set or modify the displayed string or its font.

Sticky labels are image-based. They are small images displayed on the surface. Quality of the image depends on the optimal zoom they are intended for. This zoom (and size of the image) depends on size of the font set with IDIFont, configuration of the view and model size. Before any view manipulation default size of the text is intended to be close to one normally typed in an edit box on the screen. Text size can be forced to coincide with certain geometric height in vertical direction using ILabelSection_KC.SetGeometricHeight(). If ILabelSection_KC.SetGeometricHeight() is used it is recommended to tune in the font size too for the best quality.

Properties of font and text are not modifiable (unlike the location and position properties described below). New label with changed properties has to be created instead.

Sticky Labels are created in Free state as a top-level sections. The text will be displayed on a rectangle in x and y palne of its current local frame. To apply the label to a surface:

  •  Obtain ISection interface implemented by the object to which the label will be applied
  •  Query one of IFrame* or I3DObject interfaces from iItem and modify its lcation and orientation to make it close to the surface.
  •  Query ISticky_KC  from iItem and call ISticky_KC.StickTo() to apply the label

As the result of ISticky_KC.StickTo() the label will become a child of the surface object. Call ISticky_KC.Detach() to return to Free state. An attached label can be detached from its parent using regular methods like ISection2.Detach() in which case the label will keep the conformed shape, but can be moved independently.

Position and orientation of the label can be also changed at runtime by sliding and rotating it on the surface in attached state. To do that set the current view mode to Modify with IViewModal.SetViewMode and rotate the label with the mouse. Hold shift key to translate. Setting the View mode as auto mode using SetAutoMode can be convenient in this situation.

In detached mode the same action produces normal 3D rotations and translations of the rectangle independently of any surface.

Sticky Labels in 3D Debugger

To create a sticky label in 3D Debugger in the Model > New Object > Accessoires > Label > Modify select the "Arbitrary Orientable" type on the top. For labels created this way option to make it a child of the current object is disabled in the New Object dialog as the default position is rarely acceptable.

To apply the label to a surface position and orient the label close to the surface using the Current Objetc page or Modify mode. In Model>Explore dialog set the label as current. Select the object to apply to and select Action>Join in the explorer menu.

See LabelEx Sample