SoSFColor Class Reference
[Fields]

Field containing an RGB color. More...

#include <Inventor/fields/SoSFColor.h>

Inheritance diagram for SoSFColor:
SoSField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoSFColoroperator= (const SoSFColor &f)
 SoSFColor ()
virtual ~SoSFColor ()
const SbColorgetValue () const
void setValue (const SbColor &newValue)
const SbColoroperator= (const SbColor &newValue)
int operator== (const SoSFColor &f) const
int operator!= (const SoSFColor &f) const
virtual size_t getValueSize () const
void setValue (const SbVec3f &vec)
void setValue (float r, float g, float b)
void setHSVValue (float h, float s, float v)
void setValue (const float rgb[3])
void setHSVValue (const float hsv[3])

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Field containing an RGB color.

A single-value field containing an SbColor. Values may be set in either RGB (red, green, blue) or HSV (hue, saturation, value) color spaces.

SoSFColors are written to file as an RGB triple of floating point numbers in standard scientific notation, in the range 0.0 to 1.0.

SEE ALSO

SoField, SoSField, SoMFColor, SbColor


Constructor & Destructor Documentation

SoSFColor::SoSFColor (  ) 

Default constructor.

virtual SoSFColor::~SoSFColor (  )  [virtual]

Destructor.


Member Function Documentation

static SoType SoSFColor::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoSField.

virtual SoType SoSFColor::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

const SbColor& SoSFColor::getValue (  )  const [inline]

Returns this field's value.

virtual size_t SoSFColor::getValueSize (  )  const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

int SoSFColor::operator!= ( const SoSFColor f  )  const [inline]

Returns FALSE if otherField is of the same type and has the same value as this field.

Reimplemented from SoField.

const SbColor& SoSFColor::operator= ( const SbColor newValue  )  [inline]

Sets this field to newValue.

const SoSFColor& SoSFColor::operator= ( const SoSFColor f  ) 

Copy from another field of same type.

int SoSFColor::operator== ( const SoSFColor f  )  const

Returns TRUE if otherField is of the same type and has the same value as this field.

Reimplemented from SoField.

void SoSFColor::setHSVValue ( const float  hsv[3]  ) 

Convenience method for setting the value.

void SoSFColor::setHSVValue ( float  h,
float  s,
float  v 
)

Convenience method for setting the value.

void SoSFColor::setValue ( const float  rgb[3]  ) 

Convenience method for setting the value.

void SoSFColor::setValue ( float  r,
float  g,
float  b 
)

Convenience method for setting the value.

void SoSFColor::setValue ( const SbVec3f vec  ) 

Convenience method for setting the value.

void SoSFColor::setValue ( const SbColor newValue  ) 

Sets this field to newValue.


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

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/