Click or drag to resize
PoLabel Class

Class to build a label field.

Inheritance Hierarchy

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 2024.1.1.0 (2024.1.1)
Syntax
public class PoLabel : PoChart

The PoLabel type exposes the following members.

Constructors
  NameDescription
Public methodPoLabel

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoBaseKit.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodCreatePathToPart(String, Boolean)
Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr).
(Inherited from SoBaseKit.)
Public methodCreatePathToPart(String, Boolean, SoPath)

Returns a path that begins at this nodekit and ends at partName.

(Inherited from SoBaseKit.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoBaseKit.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoBaseKit.)
Public methodStatic memberGetClassNodekitCatalog

Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.

Public methodGetDomain

Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated.

(Inherited from PoBase.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNodekitCatalog (Inherited from SoBaseKit.)
Public methodGetPart

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

(Inherited from SoBaseKit.)
Public methodGetPartString

Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part.

(Inherited from SoBaseKit.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUpdateMethod

Gets update method.

(Inherited from PoBase.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGLRender
(Inherited from SoBaseKit.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoBaseKit.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal.

(Inherited from SoBaseKit.)
Public methodIsBuilt

Indicates if the node kit has been built at least once.

(Inherited from PoBase.)
Public methodIsModified

Return true, if the kit has been modified, else otherwise.

(Inherited from PoBase.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodRebuild

Forces the node kit to be rebuilt immediately.

(Inherited from PoBase.)
Public methodSearch
(Inherited from SoBaseKit.)
Public methodSet(String)

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

(Inherited from SoBaseKit.)
Public methodSet(String, String)

This function allows field values of parts (nodes) to be set.

(Inherited from SoBaseKit.)
Public methodSetDomain

Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated.

(Inherited from PoBase.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetPart

Inserts the given node (not a copy) as the new part specified by partName.

(Inherited from SoBaseKit.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetUpdateMethod

Sets scene graph update method.

(Inherited from PoBase.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodTouchKit

Indicates the node kit is modified.

(Inherited from PoBase.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertyaxis

Defines from which axis the position and type of displayed values computation is done.

Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertycolorBinding

Specify how the colors are bound to the representation.

(Inherited from PoChart.)
Public propertycolorValuesIndex

Defines the index of the set of values for the coloring.

(Inherited from PoChart.)
Public propertyfontSize

Font size of labels.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymaterial

Defines the list of materials used for the coloring.

(Inherited from PoChart.)
Public propertyoffset

Defines an offset applied to the label.

Public propertyposition

Defines the position of the labels.

Public propertystringsIndex

Defines the index of the set of strings used for the names attached to labels when valueType is equal to NAME.

Public propertythreshold

Defines the threshold used to the set position of the label.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvalueType

Defines the type of values displayed by the labels.

Public propertyyValuesIndex

Defines the index of the set of values used by a charting representation as a y-coordinate of each mesh node.

(Inherited from PoChart.)
Top
Events
  NameDescription
Public eventPostRebuild
(Inherited from PoBase.)
Public eventPreRebuild
(Inherited from PoBase.)
Top
Remarks

Builds a 2D label field on 1D mesh (OIV.MeshViz.Nodes.PoIrregularMesh1D or OIV.MeshViz.Nodes.PoRegularMesh1D). The abscissas of the labels are given by the geometry of the current mesh 1D, and the ordinates are given by one of the value-set of the current mesh 1D specified by the field yValuesIndex. Names attached to each label are given by one of the string-set of the current mesh 1D specified by the field stringsIndex.

The fields position, threshold and offset allows the user to set the label position and the field valueType set the values to display as labels. This class also takes into account of the current mesh 1D hints (OIV.MeshViz.Nodes.PoMesh1DHints), and the current mesh 1D filter (OIV.MeshViz.Nodes.PoMesh1DFilter) to filter the geometry of the current mesh 1D. The current label hints (OIV.MeshViz.Nodes.PoLabelHints) is used to specify the appearance of labels. If the offset is different from null and, if the field isLabelLineVisible of the current label hints is set to true then, a line representing the offset is drawn. All labels depend on the current miscellaneous text attributes which defines the font names, line length and so on (OIV.MeshViz.Nodes.PoMiscTextAttr). All numerical values depend on the current numerical display format (OIV.MeshViz.Nodes.PoNumericDisplayFormat).

The interpretation of colorBinding is the following :

  • INHERITED: All labels are colored with the same inherited color.

  • PER_PART, PER_VERTEX: A color is used for each label.

FILE FORMAT/DEFAULT

OIV.MeshViz.Graph.PoLabel {
colorBinding INHERITED
yValuesIndex -1
colorValuesIndex 1
material NULL
stringsIndex 0
axis X
valueType VALUE
position VALUE_POS
threshold 0.
offset 0. 0. 0.
fontSize 0.0
}

<html> <head> <title></title> </head> <body> <h4><a name="Heading249">CATALOG PARTS</a></h4> <blockquote> <b>PoLabel</b> { </blockquote> <blockquote> <blockquote> <b>Separator</b> <tt>alternateRep</tt> (from PoBase) { </blockquote> <blockquote> <blockquote> <b>AppearanceKit</b> <tt>appearance</tt> (from PoBase) </blockquote> </blockquote> <blockquote> <blockquote> <i>Specifies the appearance of all the kit. By default lightModel.model=PHONG.</i> </blockquote> </blockquote> <blockquote> <blockquote> <b>MatrixTransform</b> <tt>domainTransform</tt> (from PoBase) </blockquote> </blockquote> <blockquote> <blockquote> <i>Corresponds to the domain transformation.</i> <b>Group</b> <tt>label</tt> </blockquote> </blockquote> <blockquote> <blockquote> <i>Contains a list of couple SoMaterial and SoText3/SoAnnoText3/SoAsciiText (cf PoBase.setTextType() and PoBase.setVRML2Mode() for choosing the text type) if the field colorBinding is different from INHERITED, a list of SoText3/SoAnnoText3/SoAsciiText otherwise.</i> <b>Separator</b> <tt>labelLineSep</tt> { <i>Contains properties and shapes to draw the label lines.</i><ul> <b>AppearanceKit</b> <tt>labelLineApp</tt> </ul> <ul> <i>Specifies the appearance of the label lines.</i> </ul> <ul> <b>Group</b> <tt>labelLine</tt> </ul> <ul> <i>Contains a SoLineSet shape to draw the label lines.</i> </ul> } </blockquote> } </blockquote> </blockquote> <blockquote> } </blockquote> </body> </html>

See Also