SoSFPlane.3coin3 - Man Page

The SoSFPlane class is a container for an SbPlane value.

Synopsis

#include <Inventor/fields/SoSFPlane.h>

Inherits SoSField.

Public Member Functions

virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoSFPlane & operator= (const SoSFPlane &field)
virtual SbBool isSame (const SoField &field) const
const SbPlane & getValue (void) const
void setValue (const SbPlane &newvalue)
const SbPlane & operator= (const SbPlane &newvalue)
int operator== (const SoSFPlane &field) const
int operator!= (const SoSFPlane &field) const

Public Member Functions inherited from SoSField
virtual ~SoSField ()

Public Member Functions inherited from SoField
virtual ~SoField ()
void setIgnored (SbBool ignore)
SbBool isIgnored (void) const
void setDefault (SbBool defaultVal)
SbBool isDefault (void) const
virtual SoType getTypeId (void) const =0
SbBool isOfType (const SoType type) const
void enableConnection (SbBool flag)
SbBool isConnectionEnabled (void) const
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
void disconnect (SoEngineOutput *engineoutput)
SbBool isConnectedFromEngine (void) const
SbBool getConnectedEngine (SoEngineOutput *&master) const
SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
void disconnect (SoField *field)
SbBool isConnectedFromField (void) const
SbBool getConnectedField (SoField *&master) const
int getNumConnections (void) const
int getForwardConnections (SoFieldList &slavelist) const
int getConnections (SoFieldList &masterlist) const
void disconnect (void)
SbBool isConnected (void) const
void setContainer (SoFieldContainer *cont)
SoFieldContainer * getContainer (void) const
SbBool set (const char *valuestring)
void get (SbString &valuestring)
SbBool shouldWrite (void) const
virtual void touch (void)
virtual void startNotify (void)
virtual void notify (SoNotList *nlist)
SbBool enableNotify (SbBool on)
SbBool isNotifyEnabled (void) const
void addAuditor (void *f, SoNotRec::Type type)
void removeAuditor (void *f, SoNotRec::Type type)
int operator== (const SoField &f) const
int operator!= (const SoField &f) const
virtual void connectionStatusChanged (int numconnections)
SbBool isReadOnly (void) const
virtual SbBool isSame (const SoField &f) const =0
virtual void copyFrom (const SoField &f)=0
virtual void fixCopy (SbBool copyconnections)
virtual SbBool referencesCopy (void) const
void copyConnection (const SoField *fromfield)
virtual SbBool read (SoInput *input, const SbName &name)
virtual void write (SoOutput *out, const SbName &name) const
virtual void countWriteRefs (SoOutput *out) const
void setFieldType (int type)
int getFieldType (void) const
SbBool getDirty (void) const
void setDirty (SbBool dirty)
void evaluate (void) const

Static Public Member Functions

static void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (void)

Static Public Member Functions inherited from SoSField
static void initClass (void)
static SoType getClassTypeId (void)
static void atexit_cleanup (void)

Static Public Member Functions inherited from SoField
static void initClass (void)
static void initClasses (void)
static void cleanupClass (void)
static SoType getClassTypeId (void)

Protected Attributes

SbPlane value

Additional Inherited Members

Public Types inherited from SoField

enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD, EXPOSED_FIELD }

Protected Member Functions inherited from SoSField
SoSField (void)

Protected Member Functions inherited from SoField
SoField (void)
void valueChanged (SbBool resetdefault=TRUE)
virtual void evaluateConnection (void) const
virtual SbBool readValue (SoInput *in)=0
virtual void writeValue (SoOutput *out) const =0
virtual SbBool readConnection (SoInput *in)
virtual void writeConnection (SoOutput *out) const
SbBool isDestructing (void) const

Detailed Description

The SoSFPlane class is a container for an SbPlane value.

This field is used where nodes, engines or other field containers needs to store a single definition of a 3D plane.

Fields of this type stores their value to file as a normalvector plus an offset from origo: 'v0 v1 v2 offset'.

See also

SoMFPlane

Member Function Documentation

SoType SoSFPlane::getTypeId (void) const [virtual]

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

See also

getClassTypeId(), SoType

Implements SoField.

void SoSFPlane::copyFrom (const SoField & f) [virtual]

Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

SbBool SoSFPlane::isSame (const SoField & f) const [virtual]

Check for equal type and value(s).

Implements SoField.

Author

Generated automatically by Doxygen for Coin from the source code.

Referenced By

The man page SoSFPlane.3coin2(3) is an alias of SoSFPlane.3coin3(3).

3.1.3" Coin