SoForeignFileKit(3) Abstract base class for foreign file format support in Coin.

SYNOPSIS


#include <ForeignFiles/SoForeignFileKit.h>

Inherits SoBaseKit.

Inherited by SoSTLFileKit.

Public Member Functions


virtual SoType getTypeId (void) const

virtual const SoNodekitCatalog * getNodekitCatalog (void) const

virtual SbBool canReadFile (const char *filename=NULL) const

virtual SbBool readFile (const char *filename)

virtual SbBool canReadScene (void) const

virtual SbBool readScene (SoNode *scene)

virtual SbBool canWriteFile (const char *filename=NULL) const

virtual SbBool writeFile (const char *filename)

virtual SbBool canWriteScene (const char *format=NULL) const

virtual SbBool writeScene (SoNode *&root, const char *format=NULL)

Static Public Member Functions


static SoType getClassTypeId (void)

static const SoNodekitCatalog * getClassNodekitCatalog (void)

static void initClass (void)

static SbBool isFileSupported (SoInput *in, SbBool exhaust=FALSE)

static SoForeignFileKit * createForeignFileKit (SoInput *in, SbBool exhaust=FALSE)

static SbBool isFileSupported (const char *filename, SbBool exhaust=FALSE)

static SoForeignFileKit * createForeignFileKit (const char *filename, SbBool exhaust=FALSE)

Public Attributes


SoSFString filename

Protected Member Functions


virtual const SoFieldData * getFieldData (void) const

Static Protected Member Functions


static const SoFieldData ** getFieldDataPtr (void)

static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

static void initClasses (void)

static SbBool registerFileExtension (SoType handler, SbName extension, SoForeignFileIdentifyFunc *identify)

Protected Attributes


SoSFNode topSeparator

Detailed Description

Abstract base class for foreign file format support in Coin.

Abstract base class for foreign file format support in Coin.

Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since:

Coin 3.0

Member Function Documentation

SoType SoForeignFileKit::getClassTypeId (void) [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Usage example: 

  void foo(SoNode * node)
  {
    if (node->getTypeId() == SoFile::getClassTypeId()) {
      SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
    }
  }

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

const SoFieldData ** SoForeignFileKit::getFieldDataPtr (void) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

const SoFieldData * SoForeignFileKit::getFieldData (void) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

const SoNodekitCatalog * SoForeignFileKit::getClassNodekitCatalog (void) [static]

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

const SoNodekitCatalog * SoForeignFileKit::getNodekitCatalog (void) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

const SoNodekitCatalog ** SoForeignFileKit::getClassNodekitCatalogPtr (void) [static], [protected]

Returns the pointer to the pointer of the nodekit catalog for this class.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

void SoForeignFileKit::initClass (void) [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

void SoForeignFileKit::initClasses (void) [static], [protected]

Initialize all the node classes of Coin.

Reimplemented from SoNode.

Author

Generated automatically by Doxygen for Coin from the source code.

LAST SEARCHED