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

CompositeMessage is the base class of all messages concerning the change of one Composite. More...

#include <message.h>

Inheritance diagram for BALL::VIEW::CompositeMessage:
Inheritance graph
[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 ()
Default Constructor.
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)
Change the composite.
Composite * getComposite () const
Inspection of the composite.
void setCompositeName (const String &name)
Change the name of the composite.
const String & getCompositeName () const
Inspection of the name of the composite.
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.


Member Enumeration Documentation

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


Constructor & Destructor Documentation

BALL::VIEW::CompositeMessage::CompositeMessage ( )

Default Constructor.

The state is set to:

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

Member Function Documentation

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

Generated on Thu Aug 6 18:30:54 2009 for BALL by doxygen 1.5.8