openvrml::sfimage Class Reference

A pixmap. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::sfimage:

List of all members.


Public Types

typedef image value_type
 Type of value.

Public Member Functions

 sfimage (const image &value=image()) throw ( std::bad_alloc )
 sfimage (const sfimage &sfi)
 Construct a copy.
virtual ~sfimage () throw ()
 Destroy.
sfimageoperator= (const sfimage &sfi) throw ( std::bad_alloc )
 Assign.
const value_typevalue () const throw ()
 Access.
void value (const value_type &val) throw ( std::bad_alloc )
 Mutate.
void swap (sfimage &sfi) throw ()
 Swap.

Static Public Attributes

static const type_id field_value_type_id = sfimage_id
 field_value::type_id for this class.

Private Member Functions

virtual std::auto_ptr
< field_value
do_clone () const throw ( std::bad_alloc )
 Polymorphically construct a copy.
virtual sfimagedo_assign (const field_value &value) throw ( std::bad_cast , std::bad_alloc )
 Virtual assignment.
virtual type_id do_type () const throw ()
 Get the field_value::type_id associated with this class.
virtual void print (std::ostream &out) const
 Print to an output stream.

Related Functions

(Note that these are not member functions.)

bool operator== (const sfimage &lhs, const sfimage &rhs) throw()
 Compare for equality.
bool operator!= (const sfimage &lhs, const sfimage &rhs) throw()
 Compare for inequality.
template<> void swap (openvrml::sfimage &a, openvrml::sfimage &b)
 Swap the values of a and b.

Detailed Description

A pixmap.

Model of
Field Value

Member Typedef Documentation


Constructor & Destructor Documentation

openvrml::sfimage::sfimage ( const image value = image()  )  throw ( std::bad_alloc ) [explicit]

Construct.

Parameters:
[in] value initial value.
Exceptions:
std::bad_alloc if memory allocation fails.

openvrml::sfimage::sfimage ( const sfimage sfi  ) 

Construct a copy.

Parameters:
[in] sfi the instance to copy.

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

Destroy.


Member Function Documentation

openvrml::sfimage & openvrml::sfimage::operator= ( const sfimage sfi  )  throw ( std::bad_alloc )

Assign.

Parameters:
[in] sfi the value to assign.
Returns:
a reference to the instance.
Exceptions:
std::bad_alloc if memory allocation fails.

const openvrml::sfimage::value_type & openvrml::sfimage::value (  )  const throw ()

Access.

Returns:
the image value.

Reimplemented from openvrml::field_value.

void openvrml::sfimage::value ( const value_type val  )  throw ( std::bad_alloc )

Mutate.

Parameters:
[in] val the new value.
Exceptions:
std::bad_alloc if memory allocation fails.

void openvrml::sfimage::swap ( sfimage sfi  )  throw ()

Swap.

Parameters:
[in,out] sfi the value to swap with this one.

std::auto_ptr< openvrml::field_value > openvrml::sfimage::do_clone (  )  const throw ( std::bad_alloc ) [private, virtual]

Polymorphically construct a copy.

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

Implements openvrml::field_value.

openvrml::sfimage & openvrml::sfimage::do_assign ( const field_value value  )  throw ( std::bad_cast , std::bad_alloc ) [private, virtual]

Virtual assignment.

Parameters:
[in] value the new value to give the object.
Returns:
a reference to the object.
Exceptions:
std::bad_cast if value is not an sfimage.
std::bad_alloc if memory allocation fails.

Implements openvrml::field_value.

openvrml::field_value::type_id openvrml::sfimage::do_type (  )  const throw () [private, virtual]

Get the field_value::type_id associated with this class.

Returns:
field_value::sfimage.

Implements openvrml::field_value.

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

Print to an output stream.

Parameters:
[in,out] out an output stream.

Implements openvrml::field_value.


Friends And Related Function Documentation

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

Compare for equality.

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

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

Compare for inequality.

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

template<> void swap ( openvrml::sfimage a,
openvrml::sfimage b 
) [related]

Swap the values of a and b.

Does not throw.

Parameters:
[in,out] a 
[in,out] b 


Member Data Documentation