PoValueLegend Class

PoValueLegend Class

Abstract class for values legend.

Inheritance Hierarchy

SystemObject
  OIV.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.GraphPoValueLegend
                      OIV.MeshViz.GraphPoAutoValueLegend

Namespace: OIV.MeshViz.Graph
Assembly: OIV.MeshViz (in OIV.MeshViz.dll) Version: 10.12.3.0 (10.12.3.0)

Syntax

C++

Copy

public class PoValueLegend : PoLegend

Public Class PoValueLegend
	Inherits PoLegend

public ref class PoValueLegend : public PoLegend

type PoValueLegend =  
    class
        inherit PoLegend
    end

The PoValueLegend type exposes the following members.

Methods

	Name	Description
	AffectsState	Returns true if a node has an effect on the state during traversal. (Inherited from SoNode.)
	Callback	(Inherited from SoBaseKit.)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	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. (Inherited from SoBaseKit.)
	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). (Inherited from SoFieldContainer.)
	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. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	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.)
	GetBoundingBox	(Inherited from SoBaseKit.)
	GetClassNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.
	GetDataMapping	Gets a reference to a OIV.MeshViz.Graph.PbDataMapping object to the association color-values.
	GetDomain	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.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetFormat	Gets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of the legend values.
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetIsovaluesList	Gets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object.
	GetMatrix	(Inherited from SoBaseKit.)
	GetMiscTextAttr	Gets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes. (Inherited from PoLegend.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetNodekitCatalog	Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. (Inherited from SoBaseKit.)
	GetPart	Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. (Inherited from SoBaseKit.)
	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. (Inherited from SoBaseKit.)
	GetPrimitiveCount	(Inherited from SoBaseKit.)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUpdateMethod	Gets update method. (Inherited from PoBase.)
	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. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. (Inherited from SoBaseKit.)
	IsBuilt	Indicates if the node kit has been built at least once. (Inherited from PoBase.)
	IsModified	Return true, if the kit has been modified, else otherwise. (Inherited from PoBase.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	(Inherited from SoBaseKit.)
	Rebuild	Forces the node kit to be rebuilt immediately. (Inherited from PoBase.)
	Search	(Inherited from SoBaseKit.)
	Set(String)	This function allows field values of parts (nodes) to be set in several different parts simultaneously. (Inherited from SoBaseKit.)
	Set(String, String)	This function allows field values of parts (nodes) to be set. (Inherited from SoBaseKit.)
	SetDataMapping	Sets a reference to a OIV.MeshViz.Graph.PbDataMapping object to the association color-values.
	SetDomain	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.)
	SetFormat	Sets a reference to a OIV.MeshViz.Graph.PbNumericDisplayFormat object for the numerical display format of the legend values.
	SetIsovaluesList	Sets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object.
	SetMiscTextAttr	Sets a reference to a OIV.MeshViz.Graph.PbMiscTextAttr for miscellaneous text attributes of all legend texts. (Inherited from PoLegend.)
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetPart	Inserts the given node (not a copy) as the new part specified by partName. (Inherited from SoBaseKit.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	SetUpdateMethod	Sets scene graph update method. (Inherited from PoBase.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	TouchKit	Indicates the node kit is modified. (Inherited from PoBase.)
	Write	(Inherited from SoBaseKit.)

Top

Properties

	Name	Description
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoBaseKit.)
	boxRatio	Ratio between width and height of the colored boxes in the legend. (Inherited from PoLegend.)
	firstValue	Number of the first value to display.
	incrementType	Increment type for the values of legend. (Inherited from PoLegend.)
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	lastValue	Number of the last value to display.
	lowerUndefString	String indicating the lower undefined level.
	marginBottom	Bottom margin. (Inherited from PoLegend.)
	marginLeft	Left margin. (Inherited from PoLegend.)
	marginRight	Right margin. (Inherited from PoLegend.)
	marginTop	Top margin. (Inherited from PoLegend.)
	marginType	Margin type. (Inherited from PoLegend.)
	numColumns	Number of columns of the legend. (Inherited from PoLegend.)
	periodValue	Period to display the values in the legend.
	titleFontName	Font name of the title. (Inherited from PoLegend.)
	titleFontSize	Font size of the title. (Inherited from PoLegend.)
	titlePath	Title path. (Inherited from PoLegend.)
	titlePosition	Title position. (Inherited from PoLegend.)
	titleString	Title string. (Inherited from PoLegend.)
	titleVisibility	Title visibility. (Inherited from PoLegend.)
	upperUndefString	String indicating the upper undefined level.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)
	valueAddString	String to be concatenated. (Inherited from PoLegend.)
	valueAddStringVisibility	Visibility of a string concatenated to the values. (Inherited from PoLegend.)
	valueFontName	Font name of values. (Inherited from PoLegend.)
	valuePosition	Values positions. (Inherited from PoLegend.)
	valueVisibility	Values visibility. (Inherited from PoLegend.)

Top

Events

	Name	Description
	PostRebuild	(Inherited from PoBase.)
	PreRebuild	(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).

Reference

OIV.MeshViz.Graph Namespace