PoLabel Class |
Class to build a label field.
Namespace: OIV.MeshViz.Graph
The PoLabel type exposes the following members.
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoBaseKit.) | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
CreatePathToPart(String, Boolean) | Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.) | |
CreatePathToPart(String, Boolean, SoPath) | Returns a path that begins at this nodekit and ends at partName. | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoBaseKit.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | (Inherited from SoBaseKit.) | |
GetClassNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class. | |
GetDomain | Gets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetMatrix | (Inherited from SoBaseKit.) | |
GetName | Returns the name of an instance. | |
GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. | |
GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
GetPartString | 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. | |
GetPrimitiveCount | (Inherited from SoBaseKit.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStringName | (Inherited from SoBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUpdateMethod | Gets update method. | |
GetViewportIsEnabled | (Inherited from SoBaseKit.) | |
GetViewportOrigin | (Inherited from SoBaseKit.) | |
GetViewportSize | (Inherited from SoBaseKit.) | |
GLRender | (Inherited from SoBaseKit.) | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoBaseKit.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. | |
IsBuilt | Indicates if the node kit has been built at least once. | |
IsModified | Return true, if the kit has been modified, else otherwise. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoBaseKit.) | |
Rebuild | Forces the node kit to be rebuilt immediately. | |
Search | (Inherited from SoBaseKit.) | |
Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
Set(String, String) | This function allows field values of parts (nodes) to be set. | |
SetDomain | Sets a reference to a OIV.MeshViz.Graph.PbDomain object used to define the data limits of the graphics to be generated. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetPart | Inserts the given node (not a copy) as the new part specified by partName. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
SetUpdateMethod | Sets scene graph update method. | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
TouchKit | Indicates the node kit is modified. | |
Write | (Inherited from SoBaseKit.) |
Name | Description | |
---|---|---|
axis | Defines from which axis the position and type of displayed values computation is done. | |
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
colorBinding | Specify how the colors are bound to the representation. | |
colorValuesIndex | Defines the index of the set of values for the coloring. | |
fontSize | Font size of labels. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
material | Defines the list of materials used for the coloring. | |
offset | Defines an offset applied to the label. | |
position | Defines the position of the labels. | |
stringsIndex | Defines the index of the set of strings used for the names attached to labels when valueType is equal to NAME. | |
threshold | Defines the threshold used to the set position of the label. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) | |
valueType | Defines the type of values displayed by the labels. | |
yValuesIndex | Defines the index of the set of values used by a charting representation as a y-coordinate of each mesh node. |
Name | Description | |
---|---|---|
PostRebuild | (Inherited from PoBase.) | |
PreRebuild | (Inherited from PoBase.) |
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.
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>