PoItemLegend Class Reference
[Legend]

Class to build an items legend. More...

#include <MeshViz/graph/PoItemLegend.h>

Inheritance diagram for PoItemLegend:

List of all members.

Public Member Functions
virtual SoType	getTypeId () const
virtual const SoNodekitCatalog *	getNodekitCatalog () const
	PoItemLegend ()
	PoItemLegend (const SbVec2f &_start, const SbVec2f &_end, int _numItems, const char **_item, const SbColor *_boxColor=NULL)
virtual void	rebuild ()
Static Public Member Functions
static SoType	getClassTypeId ()
static const SoNodekitCatalog *	getClassNodekitCatalog ()
Public Attributes
SoSFVec2f	start
SoSFVec2f	end
SoMFString	item
SoSFBool	boxVisibility
SoMFColor	boxColor
SoSFBool	lineVisibility
SoMFColor	lineColor
SoMFFloat	lineSize
SoMFUShort	linePattern
SoSFBool	markerVisibility
SoMFColor	markerColor
SoMFFloat	markerSize
SoMFString	markerString

---

Detailed Description

Class to build an items legend.

This legend associates a string (this is the values of the legend) to a box or/and a line or/and a marker. All the sizes cannot be controlled by the application and depend on the dimensions of the legend. The font size F of strings is calculated as function of the rectangle delimiting the legend. The size of the markers is equal to F. The height of the boxes is equal to 1.5 * F, and the width of the lines and of the boxes is equal to 1.5 * F * boxRatio.

FILE FORMAT/DEFAULT

PoItemLegend {

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
start	0 0
end	1 1
item	""
boxVisibility	TRUE
boxColor	0 0 0
lineVisibility	FALSE
lineColor	0 0 0
lineSize	0
linePattern	0xFFFF
markerVisibility	FALSE
markerColor	0 0 0
markerSize	0
markerString	"."

}

CATALOG PARTS

PoItemLegend {
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 lineSep {
Contains properties and shapes to draw lines of the legend.
AppearanceKit lineApp
Specifies the appearance of lines of the legend.
Group line
Contains if lines are colored, a list of couple (SoMaterial, SoLineSet), otherwise a list of SoLineSet shapes, to draw lines of the legend.
}

Separator markerSep {
Contains properties and shapes to draw markers of the legend.
AppearanceKit markerApp
Specifies the appearance of markers of the legend. If one of the strings of markerString is not equal to ".", the font used for markers is the font set in font.name.
Group marker
Contains a list of SoText2 (markerString[i] != ".") or/and SoPointSet (markerString[i] = ".") shapes to draw the markers.
}
}
}



---

Constructor & Destructor Documentation

PoItemLegend::PoItemLegend

(

)

[inline]

Default constructor.

PoItemLegend::PoItemLegend	(	const SbVec2f &	_start,
		const SbVec2f &	_end,
		int	_numItems,
		const char **	_item,
		const SbColor *	_boxColor = NULL
	)			[inline]

Constructor.

---

Member Function Documentation

static const SoNodekitCatalog* PoItemLegend::getClassNodekitCatalog

(

)

[static]

Returns the SoNodekitCatalog for this class.

Reimplemented from PoLegend.

static SoType PoItemLegend::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from PoLegend.

virtual const SoNodekitCatalog* PoItemLegend::getNodekitCatalog

(

)

const [virtual]

Returns the SoNodekitCatalog for this instance.

Reimplemented from PoLegend.

virtual SoType PoItemLegend::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoLegend.

virtual void PoItemLegend::rebuild

(

)

[virtual]

Forces node-kit rebuilding.

See PoBase.

Reimplemented from PoBase.

---

Member Data Documentation

SoMFColor PoItemLegend::boxColor

List of colors for the boxes (boxColor.getNum() must be greater or equal to item.getNum(), otherwise all boxes get the same color which is the inherited color).

SoSFBool PoItemLegend::boxVisibility

Visibility of the boxes.

SoSFVec2f PoItemLegend::end

Second point of the same diagonal.

SoMFString PoItemLegend::item

List of item names.

SoMFColor PoItemLegend::lineColor

List of colors for lines.

SoMFUShort PoItemLegend::linePattern

Be careful: (lineColor or lineSize or linePattern).getNum() must be greater or equal to item.getNum() in order to take into account one of these fields, otherwise the inherited attributes will be used.

SoMFFloat PoItemLegend::lineSize

List of sizes for lines.

SoSFBool PoItemLegend::lineVisibility

Visibility of the lines.

SoMFColor PoItemLegend::markerColor

List of color for markers.

Be careful: markerColor.getNum() must be greater or equal to item.getNum() in order to take into account one of this field, otherwise the inherited attributes will be used.

SoMFFloat PoItemLegend::markerSize

List of sizes for markers.

Be careful: markerSize.getNum() must be greater or equal to item.getNum() in order to take into account one of this field, otherwise the inherited attributes will be used.

SoMFString PoItemLegend::markerString

The markers are defined by a list of strings.

For each string of markerString equals to ".", the marker is an SoPointSet shape, otherwise an SoText2 shape. Futhermore, only the first character of each string of markerString is used. To change the font of the text markers, set catalog part markerApp.font.name. Be careful, in this version, text markers are not vertically aligned.

SoSFBool PoItemLegend::markerVisibility

Visibility of the markers.

SoSFVec2f PoItemLegend::start

First point of one of the diagonals of the rectangle delimiting the legend.

---

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