openvrml::sfvec3f Class Reference

A 3-component vector node field value. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::sfvec3f:

List of all members.


Public Types

typedef vec3f value_type
 Type of value.

Public Member Functions

 sfvec3f (const vec3f &vec=vec3f()) throw ()
 Construct.
 sfvec3f (const sfvec3f &sfv)
 Construct a copy.
virtual ~sfvec3f () throw ()
 Destroy.
sfvec3foperator= (const sfvec3f &sfv) throw ( std::bad_alloc )
 Assign.
const value_typevalue () const throw ()
 Access.
void value (const value_type &val) throw ( std::bad_alloc )
 Mutate.
void swap (sfvec3f &sfv) throw ()
 Swap.

Static Public Attributes

static const type_id field_value_type_id = sfvec3f_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 sfvec3fdo_assign (const field_value &value) throw ( std::bad_cast )
 Virtual assignment.
virtual type_id do_type () const throw ()
 Get the field_value::type_id associated with this class.
virtual void print (std::ostream &) const
 Print to an output stream.

Related Functions

(Note that these are not member functions.)

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

Detailed Description

A 3-component vector node field value.

Model of
Field Value

Member Typedef Documentation


Constructor & Destructor Documentation

openvrml::sfvec3f::sfvec3f ( const vec3f vec = vec3f()  )  throw () [explicit]

Construct.

Parameters:
[in] vec initial value.

openvrml::sfvec3f::sfvec3f ( const sfvec3f sfv  ) 

Construct a copy.

Parameters:
[in] sfv the instance to copy.

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

Destroy.


Member Function Documentation

openvrml::sfvec3f & openvrml::sfvec3f::operator= ( const sfvec3f sfv  )  throw ( std::bad_alloc )

Assign.

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

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

Access.

Returns:
the vector value.

Reimplemented from openvrml::field_value.

void openvrml::sfvec3f::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::sfvec3f::swap ( sfvec3f sfv  )  throw ()

Swap.

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

std::auto_ptr< openvrml::field_value > openvrml::sfvec3f::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::sfvec3f & openvrml::sfvec3f::do_assign ( const field_value value  )  throw ( std::bad_cast ) [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 SFBool.

Implements openvrml::field_value.

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

Get the field_value::type_id associated with this class.

Returns:
field_value::sfvec3f.

Implements openvrml::field_value.

void openvrml::sfvec3f::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 sfvec3f lhs,
const sfvec3f 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 sfvec3f lhs,
const sfvec3f 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::sfvec3f a,
openvrml::sfvec3f b 
) [related]

Swap the values of a and b.

Does not throw.

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


Member Data Documentation