SoSFNode.3coin2

Langue: en

Version: 381695 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

NAME

SoSFNode -

The SoSFNode class is a container for a single node.

This field container stores a pointer to a Coin node. It takes care of the necessary functionality for handling copy, import and export operations.

SYNOPSIS


#include <Inventor/fields/SoSFNode.h>

Inherits SoSField.

Public Member Functions


virtual SoType getTypeId (void) const

virtual void copyFrom (const SoField &field)

const SoSFNode & operator= (const SoSFNode &field)

virtual SbBool isSame (const SoField &field) const

SoNode * getValue (void) const

void setValue (SoNode *newvalue)

SoNode * operator= (SoNode *newvalue)

int operator== (const SoSFNode &field) const

int operator!= (const SoSFNode &field) const

virtual void fixCopy (SbBool copyconnections)

virtual SbBool referencesCopy (void) const

Static Public Member Functions


static void * createInstance (void)

static SoType getClassTypeId (void)

static void initClass (void)

Protected Attributes


SoNode * value

Friends


class SoMFNode

Detailed Description

The SoSFNode class is a container for a single node.

This field container stores a pointer to a Coin node. It takes care of the necessary functionality for handling copy, import and export operations.

Note that the node pointer stored in a field instance of this type may be a NULL pointer.

See also:

SoNode, SoMFNode

Member Function Documentation

SoType SoSFNode::getClassTypeId (void) [static]Returns a unique type identifier for this field class.

See also:

getTypeId(), SoType

Reimplemented from SoSField.

SoType SoSFNode::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.

int SoSFNode::operator== (const SoSFNode & f) constChecks for equality. Returns 0 if the fields are of different type or the field's value(s) are not equal.

Reimplemented from SoField.

int SoSFNode::operator!= (const SoSFNode & f) const [inline]Returns TRUE if the fields are of different type or has different value.

Reimplemented from SoField.

void SoSFNode::initClass (void) [static]Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

Reimplemented from SoSField.

void SoSFNode::fixCopy (SbBool copyconnections) [virtual]This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing.

The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i.e. nodes or engines). Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation.

Reimplemented from SoField.

References SoBase::assertAlive(), SoNode::copy(), and SoFieldContainer::findCopy().

SbBool SoSFNode::referencesCopy (void) const [virtual]Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

Note that this method only is valid to call during copy operations.

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method aswell.

Reimplemented from SoField.

References SoFieldContainer::checkCopy(), SoPath::getClassTypeId(), SoEngine::getClassTypeId(), SoNode::getClassTypeId(), SoPath::getHead(), SoBase::isOfType(), and SoField::referencesCopy().

Author

Generated automatically by Doxygen for Coin from the source code.