BALL::VIEW::CompositeMessage Class Reference
[Messages]

#include <BALL/VIEW/KERNEL/message.h>

Inheritance diagram for BALL::VIEW::CompositeMessage:

[legend]

List of all members.

Public Types
enum	CompositeMessageType {   UNDEFINED = -1, NEW_COMPOSITE, REMOVED_COMPOSITE, CHANGED_COMPOSITE,   CHANGED_COMPOSITE_HIERARCHY, SELECTED_COMPOSITE, DESELECTED_COMPOSITE, CENTER_CAMERA,   NEW_MOLECULE }
Public Member Functions
Constructors and Destructors
	CompositeMessage ()
	CompositeMessage (const Composite &composite, CompositeMessageType type, bool update_representations=true)
	CompositeMessage (const CompositeMessage &message)
	Copy constructor.
virtual	~CompositeMessage ()
	Destructor.
Accessors: inspectors and mutators
void	setComposite (const Composite &composite)
Composite *	getComposite () const
void	setCompositeName (const String &name)
const String &	getCompositeName () const
void	setType (CompositeMessageType type)
CompositeMessageType	getType () const
void	setUpdateRepresentations (bool state)
bool	updateRepresentations () const
void	setShowSelectionInfos (bool state)
bool	showSelectionInfos ()
Protected Attributes
CompositeMessageType	type_
Composite *	composite_
String	composite_name_
bool	update_representations_
bool	show_selection_infos_

---

Detailed Description

CompositeMessage is the base class of all messages concerning the change of one Composite. With it ConnectionObject can notify and react to Composite changes.

Definition at line 192 of file message.h.

---

Member Enumeration Documentation

enum BALL::VIEW::CompositeMessage::CompositeMessageType

Enumerator:

UNDEFINED	Undefinded (default) type.
NEW_COMPOSITE	A new composite to be added MolecularStructure will add bonds, normalize names and send a msg with type NEW_MOLECULE afterwards.
REMOVED_COMPOSITE	A Composite to be removed.
CHANGED_COMPOSITE	Update all datas for a Composite (but not in the MolecularControl).
CHANGED_COMPOSITE_HIERARCHY	Update all datas for a composite (also in MolecularControl).
SELECTED_COMPOSITE	selected a composite (e.g. per checkboxes in MolecularControl)
DESELECTED_COMPOSITE	deselected a composite (e.g. per checkboxes in MolecularControl)
CENTER_CAMERA	center the camera on a composite
NEW_MOLECULE	MolecularControl will add the Composite. DisplayProperties will create a Representation

Definition at line 198 of file message.h.

---

Constructor & Destructor Documentation

BALL::VIEW::CompositeMessage::CompositeMessage

(

)

Default Constructor. The state is set to:

• composite - set to 0
• composite name - set to ""

BALL::VIEW::CompositeMessage::CompositeMessage	(	const Composite &	composite,
		CompositeMessageType	type,
		bool	update_representations = true
	)

BALL::VIEW::CompositeMessage::CompositeMessage

(

const CompositeMessage &

message

)

Copy constructor.

virtual BALL::VIEW::CompositeMessage::~CompositeMessage

(

)

[virtual]

Destructor.

---

Member Function Documentation

Composite* BALL::VIEW::CompositeMessage::getComposite

(

)

const

Inspection of the composite.

const String& BALL::VIEW::CompositeMessage::getCompositeName

(

)

const

Inspection of the name of the composite.

CompositeMessageType BALL::VIEW::CompositeMessage::getType

(

)

const [inline]

Definition at line 279 of file message.h.

void BALL::VIEW::CompositeMessage::setComposite

(

const Composite &

composite

)

Change the composite.

void BALL::VIEW::CompositeMessage::setCompositeName

(

const String &

name

)

Change the name of the composite.

Parameters:

name

the new name of the composite of this compositeMessage

void BALL::VIEW::CompositeMessage::setShowSelectionInfos

(

bool

state

)

[inline]

Definition at line 291 of file message.h.

void BALL::VIEW::CompositeMessage::setType

(

CompositeMessageType

type

)

[inline]

Definition at line 275 of file message.h.

void BALL::VIEW::CompositeMessage::setUpdateRepresentations

(

bool

state

)

[inline]

Definition at line 283 of file message.h.

bool BALL::VIEW::CompositeMessage::showSelectionInfos

(

)

[inline]

Definition at line 295 of file message.h.

bool BALL::VIEW::CompositeMessage::updateRepresentations

(

)

const [inline]

Definition at line 287 of file message.h.

---

Member Data Documentation

Composite* BALL::VIEW::CompositeMessage::composite_ [protected]

Definition at line 303 of file message.h.

String BALL::VIEW::CompositeMessage::composite_name_ [protected]

Definition at line 304 of file message.h.

bool BALL::VIEW::CompositeMessage::show_selection_infos_ [protected]

Definition at line 306 of file message.h.

CompositeMessageType BALL::VIEW::CompositeMessage::type_ [protected]

Definition at line 302 of file message.h.

bool BALL::VIEW::CompositeMessage::update_representations_ [protected]

Definition at line 305 of file message.h.