Click or drag to resize
PoValueLegend Class

Abstract class for values legend.

Inheritance Hierarchy

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class PoValueLegend : PoLegend

The PoValueLegend type exposes the following members.

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 methodGetDataMapping

Gets a reference to a OIV.MeshViz.Graph.PbDataMapping object to the association color-values.

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 methodGetFormat

Gets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of the legend values.

Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetIsovaluesList

Gets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object.

Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetMiscTextAttr

Gets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes.

(Inherited from PoLegend.)
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 methodSetDataMapping

Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object to the association color-values.

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 methodSetFormat

Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of the legend values.

Public methodSetIsovaluesList

Sets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object.

Public methodSetMiscTextAttr

Sets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes of all legend texts.

(Inherited from PoLegend.)
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 propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertyboxRatio

Ratio between width and height of the colored boxes in the legend.

(Inherited from PoLegend.)
Public propertyfirstValue

Number of the first value to display.

Public propertyincrementType

Increment type for the values of legend.

(Inherited from PoLegend.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertylastValue

Number of the last value to display.

Public propertylowerUndefString

String indicating the lower undefined level.

Public propertymarginBottom

Bottom margin.

(Inherited from PoLegend.)
Public propertymarginLeft

Left margin.

(Inherited from PoLegend.)
Public propertymarginRight

Right margin.

(Inherited from PoLegend.)
Public propertymarginTop

Top margin.

(Inherited from PoLegend.)
Public propertymarginType

Margin type.

(Inherited from PoLegend.)
Public propertynumColumns

Number of columns of the legend.

(Inherited from PoLegend.)
Public propertyperiodValue

Period to display the values in the legend.

Public propertytitleFontName

Font name of the title.

(Inherited from PoLegend.)
Public propertytitleFontSize

Font size of the title.

(Inherited from PoLegend.)
Public propertytitlePath

Title path.

(Inherited from PoLegend.)
Public propertytitlePosition

Title position.

(Inherited from PoLegend.)
Public propertytitleString

Title string.

(Inherited from PoLegend.)
Public propertytitleVisibility

Title visibility.

(Inherited from PoLegend.)
Public propertyupperUndefString

String indicating the upper undefined level.

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

String to be concatenated.

(Inherited from PoLegend.)
Public propertyvalueAddStringVisibility

Visibility of a string concatenated to the values.

(Inherited from PoLegend.)
Public propertyvalueFontName

Font name of values.

(Inherited from PoLegend.)
Public propertyvaluePosition

Values positions.

(Inherited from PoLegend.)
Public propertyvalueVisibility

Values visibility.

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

This class handles a period of values, a first value and a last value to be displayed in a legend, specific strings.

Values of the legends depend on :

  • the current list of isovalues only if this list exists. In this case, values of the legend are the values defined by the current list of isovalues. The current data mapping is only used for coloring boxes of the legend.

  • the current data mapping only if the current list of isovalues does no exist. In this case, the values of the legend are the values of the current data mapping. If the current data mapping is linear, about ten values are computed. If the current data mapping is non linear of type OIV.MeshViz.Graph.PbNonLinearDataMapping or it does not exist, the list of legend values is empty. If the current data mapping is non linear of type OIV.MeshViz.Graph.PbNonLinearDataMapping2, values of the legend are the values defined by the current data mapping.

If setIsovaluesList(isovaluesList) method is called with "isovaluesList" derived from OIV.MeshViz.Graph.PbIsovaluesList, the current isovalues list is "isovaluesList". Otherwise the current isovalues list is specified in the current inherited state (cf OIV.MeshViz.Nodes.PoIsovaluesList property node). The current isovalues list does not exist if OIV.MeshViz.Graph.PoValueLegend.SetIsovaluesList(OIV.MeshViz.Graph.PbIsovaluesList) method is not called and no OIV.MeshViz.Nodes.PoIsovaluesList node is traversed before in the scene graph.

If setDataMapping(dataMapping) method is called with "dataMapping" derived from OIV.MeshViz.Graph.PbDataMapping, the current data mapping is "dataMapping". Otherwise the current data mapping is specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoDataMapping and its derived classes). The current data mapping does not exist if OIV.MeshViz.Graph.PoValueLegend.SetDataMapping(OIV.MeshViz.Graph.PbDataMapping) method is not called and no OIV.MeshViz.Nodes.PoDataMapping node is traversed before in the scene graph.

Values format depends on the current numerical display format. If the method setFormat(format) is called, the current numerical display format is "format". Otherwise the current numerical display format is specified in the current inherited state (cf property node OIV.MeshViz.Nodes.PoNumericDisplayFormat).

See Also