PoNonLinearValueLegend3 Class

Class to build a non linear legend (third representation).

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
                        OIV.MeshViz.GraphPoNonLinearValueLegend3

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 PoNonLinearValueLegend3 : PoAutoValueLegend

Public Class PoNonLinearValueLegend3
	Inherits PoAutoValueLegend

public ref class PoNonLinearValueLegend3 : public PoAutoValueLegend

type PoNonLinearValueLegend3 =  
    class
        inherit PoAutoValueLegend
    end

The PoNonLinearValueLegend3 type exposes the following members.

Constructors

	Name	Description
	PoNonLinearValueLegend3	Default constructor.
	PoNonLinearValueLegend3(SbVec2f, SbVec2f)	Constructor.

Top

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. (Inherited from PoValueLegend.)
	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. (Inherited from PoValueLegend.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetIsovaluesList	Gets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object. (Inherited from PoValueLegend.)
	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. (Inherited from PoValueLegend.)
	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. (Inherited from PoValueLegend.)
	SetIsovaluesList	Sets a reference to a OIV.MeshViz.Graph.PbIsovaluesList object. (Inherited from PoValueLegend.)
	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.)
	end	Second point of the same diagonal. (Inherited from PoAutoValueLegend.)
	firstValue	Number of the first value to display. (Inherited from PoValueLegend.)
	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. (Inherited from PoValueLegend.)
	lowerUndefString	String indicating the lower undefined level. (Inherited from PoValueLegend.)
	lowerUpperBoxes	Indicates if lower and upper boxes should be displayed.
	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.)
	maxValueSize	Indicates the maximum size of text values.
	numColumns	Number of columns of the legend. (Inherited from PoLegend.)
	periodValue	Period to display the values in the legend. (Inherited from PoValueLegend.)
	start	First point of one of the diagonals of the rectangle delimiting the legend. (Inherited from PoAutoValueLegend.)
	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. (Inherited from PoValueLegend.)
	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

Each box represents the color associated with a value of a data mapping object or an isovalue list object, so the representation is similar to the representation of OIV.MeshViz.Graph.PoNonLinearValueLegend2 but the spacing between boxes is null, and the legend consists of one column (or one row depending on the orientation of the legend).

The fields incrementType, numColumns, and boxRatio are not used for this representation.

FILE FORMAT/DEFAULT

OIV.MeshViz.Graph.PoNonLinearValueLegend3 {
titleVisibility VISIBILITY_OFF
titlePosition POS_BOTTOM
titlePath RIGHT_PATH
titleFontSize 0
titleFontName ""
titleString ""
valueVisibility VISIBILITY_ON
valuePosition POS_RIGHT
valueFontName ""
valueAddStringVisibility false
valueAddString ""
marginType REL_MARGIN
marginLeft 0.05
marginRight 0.05
marginBottom 0.05
marginTop 0.05
incrementType VERTICAL_INCREMENT
numColumns 1
boxRatio 1
periodValue 1
firstValue 1
lastValue 32767
start 0 0
end 1 1
maxValueSize 0.6
lowerUndefString "UNDEF<"
upperUndefString "UNDEF>"
lowerUpperBoxes true
}

<html> <head> <title></title> </head> <body> <h1></h1> <h4> <A NAME="Heading752">CATALOG PARTS</A></h4> <ul>PoNonLinearValueLegend3 {</ul> <ul><ul>Separator <tt>alternateRep</tt> (from PoBase) { </ul></ul> <ul><ul><ul>AppearanceKit <tt>appearance</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.</ul></ul></ul> <ul><ul><ul>MatrixTransform <tt>domainTransform</tt> (from PoBase)</ul></ul></ul> <ul><ul><ul>Corresponds to the domain transformation.</ul></ul></ul> <ul><ul><ul><ul></ul></ul></ul></ul> <ul><ul><ul>Separator <tt>backgroundSep</tt> (from PoLegend) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw the background of the legend.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>backgroundApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of the background of the legend.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>background</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoFaceSet shape to draw the background of the legend.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>backgroundBorderSep</tt> (from PoLegend) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw background border of the legend.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>backgroundBorderApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of background border of the legend.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>backgroundBorder</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw background border of the legend.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>boxSep</tt> (from PoLegend) {</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw boxes of the legend.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>boxApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of boxes of the legend.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>box</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains SoQuadMesh shape to draw boxes of the legend.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>boxBorderSep</tt> (from PoLegend){</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw borders of boxes of the legend.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>boxBorderApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of borders of boxes of the legend.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>boxBorder </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoLineSet shape to draw borders of boxes of the legend.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>titleSep</tt> (from PoLegend){</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw title of the legend.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>titleApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of title of the legend. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>title </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a SoAnnoText3 shape to draw title of the legend.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>valueTextSep</tt> (from PoLegend){</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw text of values of the legend.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>valueTextApp </tt>(from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of text of values of the legend. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>valueText</tt> (from PoLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shapes to draw text of values of the legend.</ul></ul></ul></ul> <ul><ul><ul>} Separator <tt>multFactorSep</tt> (from PoValueLegend){</ul></ul></ul> <ul><ul><ul>Contains properties and shapes to draw text of multiplicative factor.</ul></ul></ul> <ul><ul><ul><ul>AppearanceKit <tt>multFactorApp </tt>(from PoValueLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Specifies the appearance of text of multiplicative factor. By default drawStyle.style=LINES. font.size and font.name are set when the kit is rebuilt.</ul></ul></ul></ul> <ul><ul><ul><ul>Group <tt>multFactor</tt> (from PoValueLegend)</ul></ul></ul></ul> <ul><ul><ul><ul>Contains a list of SoAnnoText3 shapes to draw text of multiplicative factor.</ul></ul></ul></ul> <ul><ul><ul>}</ul></ul></ul> <ul><ul>}</ul></ul> <ul>}</ul> <ul><ul> </ul></ul> </body> </html>

Reference

OIV.MeshViz.Graph Namespace

titleVisibility	VISIBILITY_OFF
titlePosition	POS_BOTTOM
titlePath	RIGHT_PATH
titleFontSize	0
titleFontName	""
titleString	""
valueVisibility	VISIBILITY_ON
valuePosition	POS_RIGHT
valueFontName	""
valueAddStringVisibility	false
valueAddString	""
marginType	REL_MARGIN
marginLeft	0.05
marginRight	0.05
marginBottom	0.05
marginTop	0.05
incrementType	VERTICAL_INCREMENT
numColumns	1
boxRatio	1
periodValue	1
firstValue	1
lastValue	32767
start	0 0
end	1 1
maxValueSize	0.6
lowerUndefString	"UNDEF<"
upperUndefString	"UNDEF>"
lowerUpperBoxes	true