BALL::VIEW::Label Class Reference
[Geometric Objects]

Label class. More...

#include <label.h>

Inheritance diagram for BALL::VIEW::Label:

[legend]

List of all members.

Public Member Functions
Constructors
	Label ()
	Default Constructor.
	Label (const Label &label)
	Copy constructor with cloning facility.
Destructors
virtual	~Label ()
	Destructor.
virtual void	clear ()
	Explicit default initialization.
Assignment methods
void	set (const Label &label)
	Assignment.
const Label &	operator= (const Label &label)
	Assignment operator.
void	swap (Label &label)
	Swapping of label's.
Inspectors, Mutators, Accessors
void	setText (const String &text)
	Change the text of the label.
String	getText () const
	Inspection of the text of the label.
String	getExpandedText () const
	Inspection of the expanded text of the label.
const QFont &	getFont () const
void	setFont (const QFont &font)
void	setFontSize (Size size)
debuggers and diagnostics
String	text_
QFont	font_
virtual bool	isValid () const
	Internal state and consistency self-validation.
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const
	Internal value dump.
virtual void	getVertices (vector< Vector3 > &vertices) const

---

Detailed Description

Label class.

An instance of Label represents an instance of the geometric representation "label". A label is an information text that can be pinned to another Composite or GeometricObject. A label is both visible in the dynamic and static render mode of the Scene. A label has the following properties.

• color - the color of the label
• text - the text of the label
• vertex - the position of the label

  Labels support special text tags, that allows for automaticaly created text:

  • N Name
  • I Residue Id
  • T Atom type
  • C Atom charge
  • E Atom element
  • Y Atom type name

---

Constructor & Destructor Documentation

BALL::VIEW::Label::Label

(

)

Default Constructor.

Construct new label. The properties of this label are set to:

• color - to the color black
• text - to the text "unkown"
• vertex - to the vector (0,0,0)

  Returns:

  Label new constructed label

  See also:

  GeometricObject

  Vertex

BALL::VIEW::Label::Label

(

const Label &

label

)

Copy constructor with cloning facility.

Parameters:

label

the label to be copied (cloned)

See also:

GeometricObject

Vertex

---

Member Function Documentation

virtual void BALL::VIEW::Label::clear

(

)

[virtual]

Explicit default initialization.

Calls GeometricObject::clear Calls Vertex::clear

See also:

GeometricObject::clear

Vertex::clear

Reimplemented from BALL::VIEW::Vertex.

virtual void BALL::VIEW::Label::dump	(	std::ostream &	s = std::cout,
		Size	depth = 0
	)			const [virtual]

Internal value dump.

Dump the current value of this label to the output ostream s with dumping depth depth. Calls GeometricObject::dump. Calls Vertex::dump.

Parameters:

	s	output stream where to output the value of this label
	depth	the dumping depth

See also:

GeometricObject::dump

Vertex::dump

Reimplemented from BALL::VIEW::Vertex.

virtual bool BALL::VIEW::Label::isValid

(

)

const [virtual]

Internal state and consistency self-validation.

Initiate self-validation of the internal state and data structure consistencies of this label. If the internal state of this label is correct (self-validated) and consistent true is returned, false otherwise. Calls GeometricObject::isValid. Calls Vertex::isValid.

Returns:

bool true if the internal state of this label is correct (self-validated) and consistent, false otherwise

See also:

GeometricObject::isValid

Vertex::isValid

Reimplemented from BALL::VIEW::Vertex.

const Label& BALL::VIEW::Label::operator=

(

const Label &

label

)

Assignment operator.

Calls set.

void BALL::VIEW::Label::set

(

const Label &

label

)

Assignment.

Assign the label label to this label.

Parameters:

label

the label to be copied