VRS::TEXT::SimplePanel Class Reference

A simple Panel, complete with a Frame around its text. More...

#include <vrs/text/simplepanel.h>

Inheritance diagram for VRS::TEXT::SimplePanel:

List of all members.

Public Member Functions
	SimplePanel (SO< AbstractText > text)
	Constructor.
	SimplePanel (SO< AbstractText > text, SO< SimplePanel > other)
	Copy Constructor.
virtual	~SimplePanel ()
	Destructor.
virtual SO< AbstractText >	getText () const
	Sets the Text for this panel.
virtual void	setText (SO< AbstractText > at)
	Returns the Text for this panel.
virtual float	getPadding () const
	Returns the padding between frame and text in font units.
virtual void	setPadding (float pad)
	Sets the padding between frame and text in font units.
virtual void	setBackgroundColor (const Color &color, bool use=true)
	Sets the coloring of the background of this panel.
virtual Color	getBackgroundColor () const
	Returns the coloring of the background of this panel.
virtual bool	useBackgroundColor () const
	Should the backgroundcolor be used.
virtual void	setFrame (SO< ImageTexture2DGL > texture, const Bounds &topLeft, const Bounds &topCenter, const Bounds &topRight, const Bounds &middleLeft, const Bounds &middleCenter, const Bounds &middleRight, const Bounds &bottomLeft, const Bounds &bottomCenter, const Bounds &bottomRight, bool scaleFrameBorders=true)
	Sets up a Frame with a texture and the areas on the texture to be used.
virtual void	removeFrame ()
	Removes the frame, if there was any.
virtual Bounds	boundingBox () const
	The bounds of the shape (with Text-Matrix applied).
virtual Bounds	getLocalBounds () const
	The bounds of the shape (without Text-Matrix applied).
	VRS_TYPEINFO (SimplePanel, Shape)
Friends
class	SimplePanelPainterGl

---

Detailed Description

A simple Panel, complete with a Frame around its text.

---

Constructor & Destructor Documentation

VRS::TEXT::SimplePanel::SimplePanel

(

SO< AbstractText >

text

)

Constructor.

VRS::TEXT::SimplePanel::SimplePanel	(	SO< AbstractText >	text,
		SO< SimplePanel >	other
	)

Copy Constructor.

virtual VRS::TEXT::SimplePanel::~SimplePanel

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual SO<AbstractText> VRS::TEXT::SimplePanel::getText

(

)

const [virtual]

Sets the Text for this panel.

virtual void VRS::TEXT::SimplePanel::setText

(

SO< AbstractText >

at

)

[virtual]

Returns the Text for this panel.

virtual float VRS::TEXT::SimplePanel::getPadding

(

)

const [virtual]

Returns the padding between frame and text in font units.

virtual void VRS::TEXT::SimplePanel::setPadding

(

float

pad

)

[virtual]

Sets the padding between frame and text in font units.

virtual void VRS::TEXT::SimplePanel::setBackgroundColor	(	const Color &	color,
		bool	use = true
	)			[virtual]

Sets the coloring of the background of this panel.

virtual Color VRS::TEXT::SimplePanel::getBackgroundColor

(

)

const [virtual]

Returns the coloring of the background of this panel.

virtual bool VRS::TEXT::SimplePanel::useBackgroundColor

(

)

const [virtual]

Should the backgroundcolor be used.

virtual void VRS::TEXT::SimplePanel::setFrame	(	SO< ImageTexture2DGL >	texture,
		const Bounds &	topLeft,
		const Bounds &	topCenter,
		const Bounds &	topRight,
		const Bounds &	middleLeft,
		const Bounds &	middleCenter,
		const Bounds &	middleRight,
		const Bounds &	bottomLeft,
		const Bounds &	bottomCenter,
		const Bounds &	bottomRight,
		bool	scaleFrameBorders = true
	)			[virtual]

Sets up a Frame with a texture and the areas on the texture to be used.

Parameters:

	texture	The Image which contains the parts of the Frame
	bounds	The Bounds of the UV-Areas of the different parts
	scaleFrameBorders	Determines if the borders will be scaled

Should look like this:

 	____________________
 	|    |        |    |
 	| TL |   TC   | TR |
 	|____|________|____|
 	|    |        |    |
 	|    |        |    |
 	| ML |   MC   | MR |
 	|    |        |    |
 	|____|________|____|
 	|    |        |    |
 	| BL |   BC   | BR |
 	|____|________|____|
 

virtual void VRS::TEXT::SimplePanel::removeFrame

(

)

[virtual]

Removes the frame, if there was any.

virtual Bounds VRS::TEXT::SimplePanel::boundingBox

(

)

const [virtual]

The bounds of the shape (with Text-Matrix applied).

Implements VRS::Shape.

virtual Bounds VRS::TEXT::SimplePanel::getLocalBounds

(

)

const [virtual]

The bounds of the shape (without Text-Matrix applied).

VRS::TEXT::SimplePanel::VRS_TYPEINFO	(	SimplePanel	,
		Shape
	)

---

Friends And Related Function Documentation

friend class SimplePanelPainterGl [friend]

---

The documentation for this class was generated from the following file:

• simplepanel.h