Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoFile Class Reference

The SoFile class is node container for another model file.This node provides a way to split your models into a set of "component" models to include into larger "master" files. More...

#include <Inventor/nodes/SoFile.h>

Inheritance diagram for SoFile:
SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoFile (void)
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 pick (SoPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void search (SoSearchAction *action)
SoGroupcopyChildren (void) const
virtual SoChildListgetChildren (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
const SbStringgetFullName (void) const

Static Public Member Functions

static void initClass (void)
static void setSearchOK (SbBool dosearch)
static SbBool getSearchOK (void)

Public Attributes

SoSFString name

Protected Member Functions

virtual ~SoFile (void)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual SbBool readNamedFile (SoInput *in)

Detailed Description

The SoFile class is node container for another model file.

This node provides a way to split your models into a set of "component" models to include into larger "master" files.

Just provide the name of the model file to include in the SoFile::name field, and it will automatically be loaded and have its nodes inserted into the scenegraph at the point of the SoFile node.

You can also set the SoFile::name field manually. Such an action will then automatically trigger an invocation of a read operation which imports the filename you set in the field.

FILE FORMAT/DEFAULTS:

    File {
        name "<Undefined file>"
    }

Constructor & Destructor Documentation

SoFile::SoFile ( void  )
SoFile::~SoFile ( void  ) [protected, virtual]

Destructor.


Member Function Documentation

void SoFile::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 SoNode.

void SoFile::doAction ( SoAction action) [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References SoAction::getPathCode(), SoChildList::traverse(), and SoChildList::traverseInPath().

Referenced by audioRender(), callback(), getMatrix(), getPrimitiveCount(), GLRender(), handleEvent(), pick(), and search().

void SoFile::callback ( SoCallbackAction action) [virtual]

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

References doAction().

void SoFile::GLRender ( SoGLRenderAction action) [virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

References doAction().

void SoFile::getBoundingBox ( SoGetBoundingBoxAction action) [virtual]

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

References SoGetBoundingBoxAction::getCenter(), getChildren(), SbPList::getLength(), SoAction::getPathCode(), SoGetBoundingBoxAction::isCenterSet(), SoGetBoundingBoxAction::resetCenter(), SoGetBoundingBoxAction::setCenter(), and SoChildList::traverse().

void SoFile::getMatrix ( SoGetMatrixAction action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

References doAction().

void SoFile::handleEvent ( SoHandleEventAction action) [virtual]

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoNode.

References doAction().

void SoFile::pick ( SoPickAction action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

void SoFile::getPrimitiveCount ( SoGetPrimitiveCountAction action) [virtual]

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

References doAction().

void SoFile::audioRender ( SoAudioRenderAction action) [virtual]

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Reimplemented from SoNode.

References doAction().

void SoFile::search ( SoSearchAction action) [virtual]

Searching file contents through setSearchOK() was added from Coin 2.5.

See also:
setSearchOK, getSearchOK
Since:
Coin 2.5

Reimplemented from SoNode.

References doAction().

SoGroup * SoFile::copyChildren ( void  ) const

Returns a subgraph with a deep copy of the children of this node.

References SoGroup::addChild(), SoNode::copy(), SbPList::getLength(), SoBase::ref(), and SoBase::unref().

SoChildList * SoFile::getChildren ( void  ) const [virtual]

Returns list of children for this node.

Reimplemented from SoNode.

Referenced by getBoundingBox().

void SoFile::copyContents ( const SoFieldContainer from,
SbBool  copyconnections 
) [virtual]

Makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE.

This is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

For copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

  SoNode * mynewnode = templatenode->copy();

The same also goes for engines.

Make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. It should go something like this:

  void
  MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                    SbBool copyconnections)
  {
    // let parent superclasses do their thing (copy fields, copy
    // instance name, etc etc)
    SoNode::copyContents(from, copyconnections);

    // [..then copy internal data..]
  }

Reimplemented from SoNode.

References SoChildList::append(), SoFieldSensor::attach(), SoNode::copyContents(), SoFieldSensor::detach(), SoFieldContainer::findCopy(), SbPList::getLength(), name, and SoChildList::truncate().

const SbString & SoFile::getFullName ( void  ) const

Returns the read filename, possibly including the (relative) path where the file was found. Returns an empty string if no file has been read.

This method is an extension versus the Open Inventor API.

void SoFile::setSearchOK ( SbBool  dosearch) [static]

Enables/disables searching children using SoSearchAction.

Since:
Coin 2.5
SbBool SoFile::getSearchOK ( void  ) [static]

Returns whether searching children using SoSearchAction is enabled.

Since:
Coin 2.5
SbBool SoFile::readInstance ( SoInput in,
unsigned short  flags 
) [protected, virtual]

This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

References SoFieldSensor::attach(), SoFieldSensor::detach(), SbString::makeEmpty(), name, SoNode::readInstance(), and readNamedFile().

SbBool SoFile::readNamedFile ( SoInput in) [protected, virtual]

Read the file named in the SoFile::name field.

Used to be a private method, moved into protected space to enable subclasses to detect when the file is (re)read.

Since:
Coin 2.0

References SoChildList::append(), SoChildList::copy(), SoInput::eof(), SoInput::get(), SoInput::getCurFileName(), SbString::getLength(), SbString::getString(), name, SoReadError::post(), SoDebugError::postInfo(), SoDebugError::postWarning(), SoInput::pushFile(), SoInput::putBack(), SoInput::read(), and SoBase::read().

Referenced by readInstance().


Member Data Documentation

Filename for model file to insert in the scenegraph at the location of the SoFile node.

Referenced by copyContents(), readInstance(), readNamedFile(), and SoFile().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:11 for Coin by Doxygen. 1.7.3