.TH "SoForeignFileKit" 3 "Wed May 23 2012" "Version 3.1.3" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoForeignFileKit \- .PP Abstract base class for foreign file format support in Coin\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoBaseKit\fP\&. .PP Inherited by \fBSoSTLFileKit\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const " .br .ti -1c .RI "virtual const \fBSoNodekitCatalog\fP * \fBgetNodekitCatalog\fP (void) const " .br .ti -1c .RI "virtual SbBool \fBcanReadFile\fP (const char *filename=NULL) const " .br .ti -1c .RI "virtual SbBool \fBreadFile\fP (const char *filename)" .br .ti -1c .RI "virtual SbBool \fBcanReadScene\fP (void) const " .br .ti -1c .RI "virtual SbBool \fBreadScene\fP (\fBSoNode\fP *scene)" .br .ti -1c .RI "virtual SbBool \fBcanWriteFile\fP (const char *filename=NULL) const " .br .ti -1c .RI "virtual SbBool \fBwriteFile\fP (const char *filename)" .br .ti -1c .RI "virtual SbBool \fBcanWriteScene\fP (const char *format=NULL) const " .br .ti -1c .RI "virtual SbBool \fBwriteScene\fP (\fBSoNode\fP *&root, const char *format=NULL)" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP * \fBgetClassNodekitCatalog\fP (void)" .br .ti -1c .RI "static void \fBinitClass\fP (void)" .br .ti -1c .RI "static SbBool \fBisFileSupported\fP (\fBSoInput\fP *in, SbBool exhaust=FALSE)" .br .ti -1c .RI "static \fBSoForeignFileKit\fP * \fBcreateForeignFileKit\fP (\fBSoInput\fP *in, SbBool exhaust=FALSE)" .br .ti -1c .RI "static SbBool \fBisFileSupported\fP (const char *filename, SbBool exhaust=FALSE)" .br .ti -1c .RI "static \fBSoForeignFileKit\fP * \fBcreateForeignFileKit\fP (const char *filename, SbBool exhaust=FALSE)" .br .in -1c .SS "Public Attributes" .in +1c .ti -1c .RI "\fBSoSFString\fP \fBfilename\fP" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const " .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)" .br .ti -1c .RI "static const \fBSoNodekitCatalog\fP ** \fBgetClassNodekitCatalogPtr\fP (void)" .br .ti -1c .RI "static void \fBinitClasses\fP (void)" .br .ti -1c .RI "static SbBool \fBregisterFileExtension\fP (\fBSoType\fP handler, \fBSbName\fP extension, SoForeignFileIdentifyFunc *identify)" .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBtopSeparator\fP" .br .in -1c .SH "Detailed Description" .PP Abstract base class for foreign file format support in Coin\&. Abstract base class for foreign file format support in Coin\&. .PP Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2\&.1 API\&. .PP \fBSince:\fP .RS 4 Coin 3\&.0 .RE .PP .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoForeignFileKit::getClassTypeId (void)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "\fBSoType\fP SoForeignFileKit::getTypeId (void) const\fC [virtual]\fP" Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. .PP Usage example: .PP .PP .nf void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } } .fi .PP .PP For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in \fIall\fP 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), \fBInventor/engines/SoSubEngine\&.h\fP (for engine classes) and so on\&. .PP For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "const \fBSoFieldData\fP ** SoForeignFileKit::getFieldDataPtr (void)\fC [static]\fP, \fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "const \fBSoFieldData\fP * SoForeignFileKit::getFieldData (void) const\fC [protected]\fP, \fC [virtual]\fP" Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "const \fBSoNodekitCatalog\fP * SoForeignFileKit::getClassNodekitCatalog (void)\fC [static]\fP" Returns the nodekit catalog which defines the layout of this class' kit\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "const \fBSoNodekitCatalog\fP * SoForeignFileKit::getNodekitCatalog (void) const\fC [virtual]\fP" Returns the nodekit catalog which defines the layout of this class' kit\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "const \fBSoNodekitCatalog\fP ** SoForeignFileKit::getClassNodekitCatalogPtr (void)\fC [static]\fP, \fC [protected]\fP" Returns the pointer to the pointer of the nodekit catalog for this class\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "void SoForeignFileKit::initClass (void)\fC [static]\fP" Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoSTLFileKit\fP\&. .SS "void SoForeignFileKit::initClasses (void)\fC [static]\fP, \fC [protected]\fP" Initialize all the node classes of Coin\&. .PP Reimplemented from \fBSoNode\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.