| PoLegend Class |
Abstract class for legend representations.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodekitsSoBaseKit
OIV.MeshViz.GraphPoBase
OIV.MeshViz.GraphPoGraphMaster
OIV.MeshViz.GraphPoLegend
OIV.MeshViz.GraphPoItemLegend
OIV.MeshViz.GraphPoValueLegend
Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)
SyntaxThe PoLegend type exposes the following members.
Methods| 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.) |
| GetMiscTextAttr | Gets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes. |
| 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. |
| SetMiscTextAttr | Sets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes of all legend texts. |
| 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.) |
Properties| Name | Description | |
|---|---|---|
 | boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| boxRatio | Ratio between width and height of the colored boxes in the legend. |
| incrementType | Increment type for the values of legend. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| marginBottom | Bottom margin. |
| marginLeft | Left margin. |
| marginRight | Right margin. |
| marginTop | Top margin. |
| marginType | Margin type. |
| numColumns | Number of columns of the legend. |
| titleFontName | Font name of the title. |
| titleFontSize | Font size of the title. |
| titlePath | Title path. |
| titlePosition | Title position. |
| titleString | Title string. |
| titleVisibility | Title visibility. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| valueAddString | String to be concatenated. |
| valueAddStringVisibility | Visibility of a string concatenated to the values. |
| valueFontName | Font name of values. |
| valuePosition | Values positions. |
| valueVisibility | Values visibility. |
Events| Name | Description | |
|---|---|---|
 | PostRebuild | (Inherited from PoBase.) |
| PreRebuild | (Inherited from PoBase.) |
RemarksThis class handles the title, the values, the margins and the path of the legend.
All legend texts depend on the current miscellaneous text attributes which define the font name, line length and so on. If the method setMiscTextAttr(textAttr) is called, the current miscellaneous text attributes are defined by "textAttr". Otherwise the current miscellaneous text attributes are specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoMiscTextAttr).
See Also