PoLinearValueLegend Class Reference
[Legend]

Class to build a linear auto value legend. More...

#include <MeshViz/graph/PoLinearValueLegend.h>

Inheritance diagram for PoLinearValueLegend:

List of all members.

Public Types
enum	ValueDistribution {   ALL_VALUES,   LINEAR_VALUES,   MIN_MAX_VALUES }
Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoLinearValueLegend ()
	PoLinearValueLegend (const SbVec2f &_start, const SbVec2f &_end, ValueDistribution distribution=ALL_VALUES)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFEnum	valueDistribution
SoSFFloat	maxValueSize
SoSFBool	lowerUpperBoxes

---

Detailed Description

Class to build a linear auto value legend.

Class to build a linear value legend. The space between boxes is null and their width (or their height) is proportional to the difference between two consecutive values. The legend is composed of one column (or one row depending on the orientation of the legend). There are three possible representations:

• The values displayed are calculated from a data mapping object or an isovalue list object.
• The values displayed are calculated as with a linear axis. They are linearly distributed depending on the min and the max of the values of the data mapping object or the isovalue list object.
• Only the min and the max of the values of the data mapping object or the isovalue list object are displayed. The fields incrementType, numColumns, and boxRatio are not used for this representation.

FILE FORMAT/DEFAULT

PoLinearValueLegend {

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
valueDistribution	ALL_VALUES
maxValueSize	0.6
lowerUndefString	"UNDEF<"
upperUndefString	"UNDEF>"
lowerUpperBoxes	TRUE

}

CATALOG PARTS

PoLinearValueLegend {
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 a SoQuadMesh shape to draw the 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 SoLineSet shape 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.
}
}
}

---

Member Enumeration Documentation

enum PoLinearValueLegend::ValueDistribution

Type of distribution of the values.

Enumerator:

ALL_VALUES	All the values of the legend are displayed.
LINEAR_VALUES	The values of the legend are displayed like a linear axis.
MIN_MAX_VALUES	Only the minimum and maximum of the values of the legend are displayed.

---

Constructor & Destructor Documentation

PoLinearValueLegend::PoLinearValueLegend

(

)

Default constructor.

PoLinearValueLegend::PoLinearValueLegend	(	const SbVec2f &	_start,
		const SbVec2f &	_end,
		ValueDistribution	distribution = ALL_VALUES
	)

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoLinearValueLegend::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoAutoValueLegend.

static SoType PoLinearValueLegend::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoAutoValueLegend.

virtual const SoNodekitCatalog* PoLinearValueLegend::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoAutoValueLegend.

virtual SoType PoLinearValueLegend::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoAutoValueLegend.

virtual void PoLinearValueLegend::rebuild

(

)

[virtual]

Forces node kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoSFBool PoLinearValueLegend::lowerUpperBoxes

Indicates if lower and upper boxes should be displayed.

The color of the lower box is the color associated with values less than the minimum, and the color of the upper box is the color associated with values greater than the maximum.

NOTE: field available since Open Inventor 6.0

SoSFFloat PoLinearValueLegend::maxValueSize

Indicates the maximum size of text values.

If the legend is vertical, this value is the maximum percentage of the width of text values relative to the legend width (without margin). If the legend is horizontal, this value is the maximum percentage of the height of text values relative to the legend height (without margin).

SoSFEnum PoLinearValueLegend::valueDistribution

Specifies the distribution of the values.

---

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