openvrml::sfimage Class Reference

A pixmap. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::sfimage:

Public Types

typedef image value_type
 Type of value. More...
 
- Public Types inherited from openvrml::field_value
enum  type_id {
  invalid_type_id,
  sfbool_id,
  sfcolor_id,
  sfcolorrgba_id,
  sffloat_id,
  sfdouble_id,
  sfimage_id,
  sfint32_id,
  sfnode_id,
  sfrotation_id,
  sfstring_id,
  sftime_id,
  sfvec2f_id,
  sfvec2d_id,
  sfvec3f_id,
  sfvec3d_id,
  mfbool_id,
  mfcolor_id,
  mfcolorrgba_id,
  mffloat_id,
  mfdouble_id,
  mfimage_id,
  mfint32_id,
  mfnode_id,
  mfrotation_id,
  mfstring_id,
  mftime_id,
  mfvec2f_id,
  mfvec2d_id,
  mfvec3f_id,
  mfvec3d_id
}
 Used to identify field_value types. More...
 

Public Member Functions

 sfimage (const image &value=image()) throw ( std::bad_alloc )
 
 sfimage (const sfimage &sfi)
 Construct a copy. More...
 
virtual ~sfimage () throw ()
 Destroy. More...
 
sfimageoperator= (const sfimage &sfi) throw ( std::bad_alloc )
 Assign. More...
 
const value_typevalue () const throw ()
 Access. More...
 
void value (const value_type &val) throw ( std::bad_alloc )
 Mutate. More...
 
void swap (sfimage &sfi) throw ()
 Swap. More...
 
- Public Member Functions inherited from openvrml::field_value
virtual ~field_value ()=0 throw ()
 Destroy. More...
 
std::auto_ptr< field_valueclone () const throw ( std::bad_alloc )
 Polymorphically construct a copy. More...
 
field_valueassign (const field_value &value) throw ( std::bad_cast , std::bad_alloc )
 Virtual assignment. More...
 
type_id type () const throw ()
 Get the field type. More...
 
template<typename FieldValue >
const FieldValue::value_type & value () const throw ()
 Access. More...
 
template<typename FieldValue >
void value (const typename FieldValue::value_type &val) throw ( std::bad_alloc )
 Mutate. More...
 
template<typename FieldValue >
void swap (FieldValue &val) throw ()
 Swap. More...
 

Static Public Attributes

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

Private Member Functions

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

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Static Public Member Functions inherited from openvrml::field_value
static std::auto_ptr< field_valuecreate (type_id type) throw ( std::bad_alloc )
 Create a default instance of the type specified by type. More...
 
- Protected Member Functions inherited from openvrml::field_value
template<typename ValueType >
 field_value (const ValueType &value, const value_type_constructor_tag &) throw ( std::bad_alloc )
 Construct. More...
 
 field_value (const field_value &value) throw ( std::bad_alloc )
 Construct a copy. More...
 
template<typename FieldValue >
FieldValue & operator= (const FieldValue &fv) throw ( std::bad_alloc )
 Assignment operator. More...
 

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]valueinitial value.
Exceptions
std::bad_allocif memory allocation fails.
openvrml::sfimage::sfimage ( const sfimage sfi)

Construct a copy.

Parameters
[in]sfithe 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]sfithe value to assign.
Returns
a reference to the instance.
Exceptions
std::bad_allocif memory allocation fails.
const openvrml::sfimage::value_type & openvrml::sfimage::value ( ) const
throw (
)

Access.

Returns
the image value.
void openvrml::sfimage::value ( const value_type val)
throw (std::bad_alloc
)

Mutate.

Parameters
[in]valthe new value.
Exceptions
std::bad_allocif memory allocation fails.
void openvrml::sfimage::swap ( sfimage sfi)
throw (
)

Swap.

Parameters
[in,out]sfithe value to swap with this one.
std::auto_ptr< openvrml::field_value > openvrml::sfimage::do_clone ( ) const
throw (std::bad_alloc
)
privatevirtual

Polymorphically construct a copy.

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

Implements openvrml::field_value.

openvrml::sfimage & openvrml::sfimage::do_assign ( const field_value value)
throw ( std::bad_cast ,
std::bad_alloc
)
privatevirtual

Virtual assignment.

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

Implements openvrml::field_value.

openvrml::field_value::type_id openvrml::sfimage::do_type ( ) const
throw (
)
privatevirtual

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
privatevirtual

Print to an output stream.

Parameters
[in,out]outan 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]lhsleft-hand operand.
[in]rhsright-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]lhsleft-hand operand.
[in]rhsright-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

const openvrml::field_value::type_id openvrml::sfimage::field_value_type_id = sfimage_id
static

field_value::type_id for this class.