Linux Certif

Toute la documentation sur la certification Linux LPI

SoSFPath.3coin2

NAME

SoSFPath -

The SoSFPath class is a container for a single path.

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

SYNOPSIS

#include <Inventor/fields/SoSFPath.h>

Inherits SoSField.

Public Member Functions

virtual SoType getTypeId (void) const

virtual void copyFrom (const SoField &field)

const SoSFPath & operator= (const SoSFPath &field)

virtual SbBool isSame (const SoField &field) const

SoPath * getValue (void) const

void setValue (SoPath *newvalue)

SoPath * operator= (SoPath *newvalue)

int operator== (const SoSFPath &field) const

int operator!= (const SoSFPath &field) const

virtual void notify (SoNotList *l)

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

SoPath * value

Friends

class SoMFPath

Detailed Description

The SoSFPath class is a container for a single path.

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

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

See also:

SoPath, SoMFPath

Member Function Documentation

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

See also:

getTypeId(), SoType

Reimplemented from SoSField.

SoType SoSFPath::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 SoSFPath::operator== (const SoSFPath & 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 SoSFPath::operator!= (const SoSFPath & f) const [inline]Returns TRUE if the fields are of different type or has different value.

Reimplemented from SoField.

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

Reimplemented from SoSField.

void SoSFPath::notify (SoNotList * nlist) [virtual]Notify auditors that this field has changed.

Reimplemented from SoField.

References SoBase::addAuditor(), SoPath::getHead(), SoField::notify(), SoBase::ref(), SoBase::removeAuditor(), and SoBase::unref().

void SoSFPath::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(), SoPath::copy(), and SoFieldContainer::findCopy().

SbBool SoSFPath::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.