openvrml::sfcolor Class Reference
[Field Values]

Inheritance diagram for openvrml::sfcolor:
[legend]

List of all members.


Detailed Description

A color node field value.

Model of
FieldValue

Public Types

typedef color value_type
 Type of value.

Public Member Functions

 sfcolor (const color &value=color()) throw ()
 Construct.
virtual ~sfcolor () throw ()
 Destroy.
virtual std::auto_ptr
< field_value
clone () const throw (std::bad_alloc)
 Virtual copy constructor.
virtual field_valueassign (const field_value &value) throw (std::bad_cast)
 Virtual assignment.
virtual type_id type () const throw ()
 Get the field_value::type_id associated with this class.

Public Attributes

color value
 Color value.

Private Member Functions

virtual void print (std::ostream &out) const
 Print to an output stream.

Related Functions

(Note that these are not member functions.)

bool operator== (const sfcolor &lhs, const sfcolor &rhs) throw()
 Compare for equality.
bool operator!= (const sfcolor &lhs, const sfcolor &rhs) throw()
 Compare for inequality.

Member Typedef Documentation

Type of value.


Constructor & Destructor Documentation

openvrml::sfcolor::sfcolor ( const color value = color()  )  throw () [explicit]

Construct.

Parameters:
value initial value.

openvrml::sfcolor::~sfcolor (  )  throw () [virtual]

Destroy.


Member Function Documentation

std::auto_ptr< field_value > openvrml::sfcolor::clone (  )  const throw (std::bad_alloc) [virtual]

Virtual copy constructor.

Returns:
a pointer to a copy of the object.
Exceptions:
std::bad_alloc if memory allocation fails.

Implements openvrml::field_value.

field_value & openvrml::sfcolor::assign ( const field_value value  )  throw (std::bad_cast) [virtual]

Virtual assignment.

Parameters:
value the new value to give the object.
Returns:
a reference to the object.
Exceptions:
std::bad_cast if value is not an SFColor.

Implements openvrml::field_value.

field_value::type_id openvrml::sfcolor::type (  )  const throw () [virtual]

Get the field_value::type_id associated with this class.

Returns:
field_value::sfcolor.

Implements openvrml::field_value.

void openvrml::sfcolor::print ( std::ostream &  out  )  const [private, virtual]

Print to an output stream.

Parameters:
out an output stream.

Implements openvrml::field_value.


Friends And Related Function Documentation

bool operator== ( const sfcolor lhs,
const sfcolor rhs 
) throw() [related]

Compare for equality.

Parameters:
lhs left-hand operand.
rhs right-hand operand.
Returns:
true if lhs and rhs have the same value; false otherwise.

bool operator!= ( const sfcolor lhs,
const sfcolor rhs 
) throw() [related]

Compare for inequality.

Parameters:
lhs left-hand operand.
rhs right-hand operand.
Returns:
true if lhs and rhs do not have the same value; false otherwise.


Member Data Documentation

Color value.