Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Static Public Member Functions | Protected Member Functions

SoSField Class Reference

The SoSField class is the base class for fields which contains only a single value.All field types which should always contain only a single member value inherits this class. SoSField is an abstract class. More...

#include <Inventor/fields/SoSField.h>

Inheritance diagram for SoSField:
SoField SoSFBool SoSFBox2d SoSFBox2f SoSFBox2i32 SoSFBox2s SoSFBox3d SoSFBox3f SoSFBox3i32 SoSFBox3s SoSFColor SoSFColorRGBA SoSFDouble SoSFEngine SoSFEnum SoSFFloat SoSFImage SoSFImage3 SoSFInt32 SoSFMatrix SoSFName SoSFNode SoSFPath SoSFPlane SoSFRotation SoSFShort SoSFString SoSFTime SoSFTrigger SoSFUInt32 SoSFUShort SoSFVec2b SoSFVec2d SoSFVec2f SoSFVec2i32 SoSFVec2s SoSFVec3b SoSFVec3d SoSFVec3f SoSFVec3i32 SoSFVec3s SoSFVec4b SoSFVec4d SoSFVec4f SoSFVec4i32 SoSFVec4s SoSFVec4ub SoSFVec4ui32 SoSFVec4us

List of all members.

Public Member Functions

virtual ~SoSField ()

Static Public Member Functions

static void initClass (void)
static SoType getClassTypeId (void)

Protected Member Functions

 SoSField (void)

Detailed Description

The SoSField class is the base class for fields which contains only a single value.

All field types which should always contain only a single member value inherits this class. SoSField is an abstract class.

You use methods setValue() and getValue() to store or fetch the value of single-value fields. Example:

    SoSpotLight * lightnode = new SoSpotLight;
    lightnode->on.setValue(TRUE); // The "on" field of SoSpotLight is
                                  // a single value field of type SoSFBool.
    ...
    ...
    // Change lightswitch.
    if (lightnode->on.getValue() == FALSE)
      lightnode->on = TRUE; // We can use operator = instead of setValue().
    else
      lightnode->on = FALSE;
    ...

When nodes, engines or other types of field containers are written to file, their single-value fields are written to file in this format:

    containerclass {
      fieldname value
      fieldname value
      ...
    }

..like this, for instance, a SpotLight node from a scene graph which will be default off when read back from file:

    SpotLight {
      on FALSE
    }
See also:
SoMField

Constructor & Destructor Documentation

SoSField::~SoSField ( ) [virtual]

The SoSField destructor is empty, and is only defined so we could make it virtual.

SoSField::SoSField ( void  ) [protected]

The SoSField constructor is protected, as this is an abstract class.


Member Function Documentation

void SoSField::initClass ( void  ) [static]
SoType SoSField::getClassTypeId ( void  ) [static]

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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:19 for Coin by Doxygen. 1.7.3