PoNonLinearValueLegend1 Class Reference
[Legend]

Class to build a non linear legend (first representation). More...

#include <MeshViz/graph/PoNonLinearValueLegend1.h>

Inheritance diagram for PoNonLinearValueLegend1:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoNonLinearValueLegend1 ()
	PoNonLinearValueLegend1 (const SbVec2f &_start, const SbVec2f &_end)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFString	lessLevelString
SoSFString	greaterLevelString
SoSFString	valueSeparatorString

---

Detailed Description

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

Each color box represents a value (or level) which is between two consecutive values of a data mapping object or an isovalue list object.

FILE FORMAT/DEFAULT

PoNonLinearValueLegend1 {

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
lessLevelString	"<"
greaterLevelString	">"
valueSeparatorString	" _ "
lowerUndefString	"UNDEF<"
upperUndefString	"UNDEF>"

}

CATALOG PARTS

PoNonLinearValueLegend1 {
Separator alternateRep (from PoBase) {

AppearanceKit appearance (from PoBase)
Specifies the appearance of all the kit. By default lightModel.model=BASE_COLOR.
MatrixTransform domainTransform (from PoBase)
Corresponds to the domain transformation.
Separator backgroundSep (from PoLegend) {
Contains properties and shapes to draw the background of the legend.
AppearanceKit backgroundApp (from PoLegend)
Specifies the appearance of the background of the legend.
Group background (from PoLegend)
Contains a SoFaceSet shape to draw the background of the legend.
}

Separator backgroundBorderSep (from PoLegend) {
Contains properties and shapes to draw background border of the legend.
AppearanceKit backgroundBorderApp (from PoLegend)
Specifies the appearance of background border of the legend.
Group backgroundBorder (from PoLegend)
Contains a SoLineSet shape to draw background border of the legend.
}

Separator boxSep (from PoLegend) {
Contains properties and shapes to draw boxes of the legend.
AppearanceKit boxApp (from PoLegend)
Specifies the appearance of boxes of the legend.
Group box (from PoLegend)
Contains if boxes are colored, a list of couple (SoMaterial, SoFaceSet), otherwise a list of SoFaceSet shapes, to draw boxes of the legend.
}
Separator boxBorderSep (from PoLegend){
Contains properties and shapes to draw borders of boxes of the legend.
AppearanceKit boxBorderApp (from PoLegend)
Specifies the appearance of borders of boxes of the legend.
Group boxBorder (from PoLegend)
Contains a list of SoLineSet shapes to draw borders of boxes of the legend.
}

Separator titleSep (from PoLegend){
Contains properties and shapes to draw title of the legend.
AppearanceKit titleApp (from PoLegend)
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.
Group title (from PoLegend)
Contains a SoAnnoText3 shape to draw title of the legend.
}

Separator valueTextSep (from PoLegend){
Contains properties and shapes to draw text of values of the legend.
AppearanceKit valueTextApp (from PoLegend)
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.
Group valueText (from PoLegend)
Contains a list of SoAnnoText3 shapes to draw text of values of the legend.
}

Separator multFactorSep (from PoValueLegend){
Contains properties and shapes to draw text of multiplicative factor.
AppearanceKit multFactorApp (from PoValueLegend)
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.
Group multFactor (from PoValueLegend)
Contains a list of SoAnnoText3 shapes to draw text of multiplicative factor.
}
}
}

---

Constructor & Destructor Documentation

PoNonLinearValueLegend1::PoNonLinearValueLegend1

(

)

Default constructor.

PoNonLinearValueLegend1::PoNonLinearValueLegend1	(	const SbVec2f &	_start,
		const SbVec2f &	_end
	)

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoNonLinearValueLegend1::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoAutoValueLegend.

static SoType PoNonLinearValueLegend1::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoAutoValueLegend.

virtual const SoNodekitCatalog* PoNonLinearValueLegend1::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoAutoValueLegend.

virtual SoType PoNonLinearValueLegend1::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoAutoValueLegend.

virtual void PoNonLinearValueLegend1::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFString PoNonLinearValueLegend1::greaterLevelString

String used for the highest level.

SoSFString PoNonLinearValueLegend1::lessLevelString

String used for the lowest level.

SoSFString PoNonLinearValueLegend1::valueSeparatorString

String separator used between two consecutive values.

---

The documentation for this class was generated from the following file:
• MeshViz/graph/PoNonLinearValueLegend1.h