SoSFPath(3)

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

  Additional Inherited Members

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::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 SoSFPath::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 SoSFPath::isSame (const SoField & f) const [virtual]
Check for equal type and value(s).

Implements SoField.

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

Reimplemented from SoField.

  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.

  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.

Author

Generated automatically by Doxygen for Coin from the source code.