In This Package:

VisAttribute Class Reference

This encapsulated the definition of visualization attributes for either a logical volume or a material. More...

#include <VisAttribute.h>

Collaboration diagram for VisAttribute:

[legend]List of all members.

Public Types
	VISIBLE
	NOT_VISIBLE
	NO_VISIBILITY
	OPENED
	CLOSED
	NO_STATUS
	PLAIN
	WIRE_FRAME
	NO_MODE
enum	Visibility { VISIBLE, NOT_VISIBLE, NO_VISIBILITY }
enum	OpenStatus { OPENED, CLOSED, NO_STATUS }
enum	DisplayMode { PLAIN, WIRE_FRAME, NO_MODE }
Public Member Functions
	VisAttribute ()
	Default constructor.
	VisAttribute (Visibility visible, OpenStatus openStatus, DisplayMode displayMode, Color color)
	Standard constructor.
const Color	color () const
	Get accessor to member m_color.
const Visibility	visible () const
	Get accessor to member m_visible.
const OpenStatus	openStatus () const
	Get accessor to member m_openStatus.
const DisplayMode	displayMode () const
	Get accessor to member m_displayMode.
void	merge (const VisAttribute attr)
	Merges an attribute with this one.
bool	operator== (const VisAttribute &v) const
	equality operator for VisAttribute
bool	operator!= (const VisAttribute &v) const
	unequality operator for VisAttribute
Private Attributes
Color	m_color
Visibility	m_visible
OpenStatus	m_openStatus
DisplayMode	m_displayMode

---

Detailed Description

This encapsulated the definition of visualization attributes for either a logical volume or a material.

Included attributes are :

• color
• visibility
• opening state at display time : open means that the children are displayed
• display mode : plain or wireframe

Author:

Sebastien Ponce

Date:

2002-06-25

Definition at line 20 of file VisAttribute.h.

---

Member Enumeration Documentation

enum VisAttribute::Visibility

Enumerator:

VISIBLE
NOT_VISIBLE
NO_VISIBILITY

Definition at line 23 of file VisAttribute.h.

{VISIBLE, NOT_VISIBLE, NO_VISIBILITY};

enum VisAttribute::OpenStatus

Enumerator:

OPENED
CLOSED
NO_STATUS

Definition at line 24 of file VisAttribute.h.

{OPENED, CLOSED, NO_STATUS};

enum VisAttribute::DisplayMode

Enumerator:

PLAIN
WIRE_FRAME
NO_MODE

Definition at line 25 of file VisAttribute.h.

{PLAIN, WIRE_FRAME, NO_MODE};

---

Constructor & Destructor Documentation

VisAttribute::VisAttribute

(

)

[inline]

Default constructor.

Definition at line 29 of file VisAttribute.h.

                  :
    m_color(),
    m_visible(NO_VISIBILITY),
    m_openStatus(NO_STATUS),
    m_displayMode(NO_MODE)
  {};

VisAttribute::VisAttribute	(	Visibility	visible,
		OpenStatus	openStatus,
		DisplayMode	displayMode,
		Color	color
	)			[inline]

Standard constructor.

Definition at line 37 of file VisAttribute.h.

                             :
    m_color(color),
    m_visible(visible),
    m_openStatus(openStatus),
    m_displayMode(displayMode)
  {};  

---

Member Function Documentation

const Color VisAttribute::color

(

)

const [inline]

Get accessor to member m_color.

Returns:

the current value of m_color

Definition at line 51 of file VisAttribute.h.

                            {
    return m_color;
  }

const Visibility VisAttribute::visible

(

)

const [inline]

Get accessor to member m_visible.

Returns:

the current value of m_visible

Definition at line 59 of file VisAttribute.h.

                                   {
    return m_visible;
  }

const OpenStatus VisAttribute::openStatus

(

)

const [inline]

Get accessor to member m_openStatus.

Returns:

the current value of m_openStatus

Definition at line 67 of file VisAttribute.h.

                                      {
    return m_openStatus;
  }

const DisplayMode VisAttribute::displayMode

(

)

const [inline]

Get accessor to member m_displayMode.

Returns:

the current value of m_displayMode

Definition at line 75 of file VisAttribute.h.

                                        {
    return m_displayMode;
  }

void VisAttribute::merge

(

const VisAttribute

attr

)

[inline]

Merges an attribute with this one.

This one has precedence but every undefined member will be defined using the other attribute

Parameters:

attr

the attribute to merge with this one

Definition at line 85 of file VisAttribute.h.

                                      {
    if (!m_color.isValid()) m_color = attr.color();
    if (NO_VISIBILITY == m_visible) m_visible = attr.visible();
    if (NO_STATUS == m_openStatus) m_openStatus = attr.openStatus();
    if (NO_MODE == m_displayMode) m_displayMode = attr.displayMode();
    return;
  }

bool VisAttribute::operator==

(

const VisAttribute &

v

)

const [inline]

equality operator for VisAttribute

Definition at line 96 of file VisAttribute.h.

                                                {
    return m_visible == v.visible() && 
      m_openStatus == v.openStatus() &&
      m_displayMode == v.displayMode() &&
      m_color == v.color();
  }

bool VisAttribute::operator!=

(

const VisAttribute &

v

)

const [inline]

unequality operator for VisAttribute

Definition at line 106 of file VisAttribute.h.

                                                {
    return !this->operator==(v);
  }

---

Member Data Documentation

Color VisAttribute::m_color [private]

Definition at line 111 of file VisAttribute.h.

Visibility VisAttribute::m_visible [private]

Definition at line 112 of file VisAttribute.h.

OpenStatus VisAttribute::m_openStatus [private]

Definition at line 113 of file VisAttribute.h.

DisplayMode VisAttribute::m_displayMode [private]

Definition at line 114 of file VisAttribute.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/lhcb/Vis/VisSvc/VisSvc/VisAttribute.h

---