Coin Logo http://www.coin3d.org/
http://www.kongsberg.com/kogt/

Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
SoForeignFileKit Class Referenceabstract

Abstract base class for foreign file format support in Coin. More...

#include <ForeignFiles/SoForeignFileKit.h>

Inheritance diagram for SoForeignFileKit:
SoBaseKit SoNode SoFieldContainer SoBase SoSTLFileKit

Public Member Functions

virtual SoType getTypeId (void) const
 Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. More...
 
virtual const SoNodekitCataloggetNodekitCatalog (void) const
 
virtual SbBool canReadFile (const char *filename=NULL) const
 
virtual SbBool readFile (const char *filename)
 
virtual SbBool canWriteFile (const char *filename=NULL) const
 
virtual SbBool writeFile (const char *filename)
 
virtual class SoSeparatorconvert ()=0
 
- Public Member Functions inherited from SoBaseKit
 SoBaseKit (void)
 
virtual SoNodegetPart (const SbName &partname, SbBool makeifneeded)
 
SbString getPartString (const SoBase *part)
 
virtual SoNodeKitPathcreatePathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
 
virtual SbBool setPart (const SbName &partname, SoNode *from)
 
SbBool set (const char *namevaluepairliststring)
 
SbBool set (const char *partnamestring, const char *parameterstring)
 
virtual void doAction (SoAction *action)
 
virtual void callback (SoCallbackAction *action)
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void handleEvent (SoHandleEventAction *action)
 
virtual void rayPick (SoRayPickAction *action)
 
virtual void search (SoSearchAction *action)
 
virtual void write (SoWriteAction *action)
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 
virtual SoChildListgetChildren (void) const
 
void printDiagram (void)
 
void printSubDiagram (const SbName &rootname, int level)
 
void printTable (void)
 
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
 
SbBool forceChildDrivenWriteRefs (SoOutput *out)
 
- Public Member Functions inherited from SoNode
void setOverride (const SbBool state)
 
SbBool isOverride (void) const
 
void setNodeType (const NodeType type)
 
NodeType getNodeType (void) const
 
virtual SoNodecopy (SbBool copyconnections=FALSE) const
 
virtual SbBool affectsState (void) const
 
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 
virtual void GLRenderInPath (SoGLRenderAction *action)
 
virtual void GLRenderOffPath (SoGLRenderAction *action)
 
virtual void pick (SoPickAction *action)
 
virtual void audioRender (SoAudioRenderAction *action)
 
virtual void grabEventsSetup (void)
 
virtual void grabEventsCleanup (void)
 
virtual void startNotify (void)
 
virtual void notify (SoNotList *l)
 
uint32_t getNodeId (void) const
 
virtual void writeInstance (SoOutput *out)
 
virtual SoFieldContainercopyThroughConnection (void) const
 
- Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)
 
SbBool hasDefaultValues (void) const
 
SbBool fieldsAreEqual (const SoFieldContainer *container) const
 
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)
 
SbBool set (const char *const fielddata)
 
void get (SbString &fielddata)
 
virtual int getFields (SoFieldList &l) const
 
virtual int getAllFields (SoFieldList &l) const
 
virtual SoFieldgetField (const SbName &name) const
 
virtual SoFieldgetEventIn (const SbName &name) const
 
virtual SoFieldgetEventOut (const SbName &name) const
 
SbBool getFieldName (const SoField *const field, SbName &name) const
 
SbBool enableNotify (const SbBool flag)
 
SbBool isNotifyEnabled (void) const
 
SbBool set (const char *fielddata, SoInput *input)
 
void get (SbString &fielddata, SoOutput *out)
 
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
 
SbBool getIsBuiltIn (void) const
 
virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
 
void setUserData (void *userdata) const
 
void * getUserData (void) const
 
- Public Member Functions inherited from SoBase
void ref (void) const
 
void unref (void) const
 
void unrefNoDelete (void) const
 
int32_t getRefCount (void) const
 
void touch (void)
 
SbBool isOfType (SoType type) const
 Returns TRUE if the type of this object is either of the same type or inherited from type. More...
 
virtual SbName getName (void) const
 
virtual void setName (const SbName &newname)
 
void addAuditor (void *const auditor, const SoNotRec::Type type)
 
void removeAuditor (void *const auditor, const SoNotRec::Type type)
 
const SoAuditorListgetAuditors (void) const
 
SbBool shouldWrite (void)
 
void assertAlive (void) const
 

Static Public Member Functions

static SoType getClassTypeId (void)
 
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static void initClass (void)
 
static SbBool isFileSupported (SoInput *in, SbBool exhaust=FALSE)
 
static SbBool isFileSupported (const char *filename, SbBool exhaust=FALSE)
 
static SoForeignFileKitcreateForeignFileKit (SoInput *in, SbBool exhaust=FALSE)
 
static SoForeignFileKitcreateForeignFileKit (const char *filename, SbBool exhaust=FALSE)
 
- Static Public Member Functions inherited from SoBaseKit
static SoType getClassTypeId (void)
 
static void initClass (void)
 
static const SoNodekitCataloggetClassNodekitCatalog (void)
 
static SbBool isSearchingChildren (void)
 
static void setSearchingChildren (const SbBool newval)
 
- Static Public Member Functions inherited from SoNode
static uint32_t getCompatibilityTypes (const SoType &nodetype)
 
static SoType getClassTypeId (void)
 
static SoNodegetByName (const SbName &name)
 
static int getByName (const SbName &name, SoNodeList &l)
 
static void initClass (void)
 
static void initClasses (void)
 
static uint32_t getNextNodeId (void)
 
static int getActionMethodIndex (const SoType type)
 
static void getBoundingBoxS (SoAction *action, SoNode *node)
 
static void GLRenderS (SoAction *action, SoNode *node)
 
static void callbackS (SoAction *action, SoNode *node)
 
static void getMatrixS (SoAction *action, SoNode *node)
 
static void handleEventS (SoAction *action, SoNode *node)
 
static void pickS (SoAction *action, SoNode *node)
 
static void rayPickS (SoAction *action, SoNode *node)
 
static void searchS (SoAction *action, SoNode *node)
 
static void writeS (SoAction *action, SoNode *node)
 
static void audioRenderS (SoAction *action, SoNode *node)
 
static void getPrimitiveCountS (SoAction *action, SoNode *node)
 
- Static Public Member Functions inherited from SoFieldContainer
static void initClass (void)
 
static SoType getClassTypeId (void)
 
static void cleanupClass (void)
 
static void initCopyDict (void)
 
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
 
static SoFieldContainercheckCopy (const SoFieldContainer *orig)
 
static SoFieldContainerfindCopy (const SoFieldContainer *orig, const SbBool copyconnections)
 
static void copyDone (void)
 
- Static Public Member Functions inherited from SoBase
static void initClass (void)
 Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
 
static SoType getClassTypeId (void)
 This static method returns the SoType object associated with objects of this class.
 
static void addName (SoBase *const base, const char *const name)
 
static void removeName (SoBase *const base, const char *const name)
 
static void incrementCurrentWriteCounter (void)
 
static void decrementCurrentWriteCounter (void)
 
static SoBasegetNamedBase (const SbName &name, SoType type)
 
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
 
static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 
static SbBool getTraceRefs (void)
 
static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static SbBool readRoute (SoInput *input)
 

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 
- Protected Member Functions inherited from SoBaseKit
virtual ~SoBaseKit ()
 
virtual SoNodeaddToCopyDict (void) const
 
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
 
SoGroupgetContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
 
virtual SoNodegetAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
 
virtual SoNodeKitPathcreatePathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
 
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
 
void createNodekitPartsList (void)
 
void createFieldList (void)
 
virtual void createDefaultParts (void)
 
const SoNodekitParts * getNodekitPartsList (void) const
 
const SbList< SoSFNode * > & getCatalogInstances (void) const
 
void catalogError (void)
 
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
virtual void setDefaultOnNonWritingFields (void)
 
void countMyFields (SoOutput *out)
 
virtual SbBool setPart (const int partNum, SoNode *node)
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
virtual ~SoFieldContainer ()
 
- Protected Member Functions inherited from SoBase
 SoBase (void)
 
virtual ~SoBase ()
 
virtual void destroy (void)
 
SbBool hasMultipleWriteRefs (void) const
 
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
 
void writeFooter (SoOutput *out) const
 
virtual const char * getFileFormatName (void) const
 
virtual SoNotRec createNotRec (void)
 

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)
 
- Static Protected Member Functions inherited from SoBaseKit
static const SoFieldData ** getFieldDataPtr (void)
 
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)
 
- Static Protected Member Functions inherited from SoNode
static const SoFieldData ** getFieldDataPtr (void)
 
static void setNextActionMethodIndex (int index)
 
static int getNextActionMethodIndex (void)
 
static void incNextActionMethodIndex (void)
 
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)
 
- Static Protected Member Functions inherited from SoBase
static uint32_t getCurrentWriteCounter (void)
 
static void staticDataLock (void)
 
static void staticDataUnlock (void)
 

Protected Attributes

SoSFNode topSeparator
 
- Protected Attributes inherited from SoBaseKit
SoSFNode callbackList
 
SoChildListchildren
 
SbBool connectionsSetUp
 
- Protected Attributes inherited from SoNode
uint32_t uniqueId
 
- Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn
 

Additional Inherited Members

- Public Types inherited from SoNode
enum  NodeType {
  INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004,
  INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040,
  COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400,
  COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000,
  COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000
}
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
 
- Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 1
 
static int nextActionMethodIndex = 0
 

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::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::getFieldData ( void  ) const
protectedvirtual

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::getNodekitCatalog ( void  ) const
virtual

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

Reimplemented from SoBaseKit.

Reimplemented in SoSTLFileKit.

SbBool SoForeignFileKit::isFileSupported ( SoInput in,
SbBool  exhaust = FALSE 
)
static

Convenience method. Will extract the filename from in and call the other ieFileSupported() method.

Will return false if file is not supported or /e in is not representing a normal file.

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

Checks if the filename can be read by a registered SoForeignFileKit handler.

FIXME: exhaust is not implemented.

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

Convenience method. Will extract the filename from in and call the other ieFileSupported() method.

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

Creates an instance of a suitable SoForeignFileKit subtype from the given file and reads its content. Returns NULL on failure or a kit with refcount of 0 on success.

FIXME: exhaust is not implemented.

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

Checks if this concrete class can read the given file.

Reimplemented in SoSTLFileKit.

SbBool SoForeignFileKit::readFile ( const char *  filename)
virtual

Reads the given file into the internal representation. If successful, Coin should now be able to render the scene. If you need a pure Coin scenegraph, call convert().

Reimplemented in SoSTLFileKit.

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

Checks if this concrete class can write to the given file.

Reimplemented in SoSTLFileKit.

SbBool SoForeignFileKit::writeFile ( const char *  filename)
virtual

Writes the current contents to the given file.

See also
canWriteFile

Reimplemented in SoSTLFileKit.

virtual class SoSeparator* SoForeignFileKit::convert ( )
pure virtual

Converts (if necessary) the internal representation of the foreign file to a pure Coin scenegraph. Returns the root node with a refcount of 0.

Implemented in SoSTLFileKit.

SbBool SoForeignFileKit::registerFileExtension ( SoType  handler,
SbName  extension,
SoForeignFileIdentifyFunc *  identify 
)
staticprotected

Registers a concrete SoForeignFileKit subtype to be a handler for files with the given extension. One class can be a handler for multiple filename extensions.

FIXME: identify is not implemented


The documentation for this class was generated from the following files:

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.

Generated for Coin by Doxygen