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

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions
SoShuttle Class Reference

The SoShuttle class is used to oscillate between two translations.A smooth transition between translation0 and translation1 is created using a cosine function. In the beginning of the cycle, translation0 is used. Halfway through the cycle, the resulting translation equals translation1, and at the end of the cycle, we're at translation0 again. More...

#include <Inventor/nodes/SoShuttle.h>

Inheritance diagram for SoShuttle:
SoTranslation SoTransformation SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
 SoShuttle (void)
virtual void write (SoWriteAction *action)

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Public Attributes

SoSFVec3f translation0
SoSFVec3f translation1
SoSFFloat speed
SoSFBool on

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoShuttle ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Detailed Description

The SoShuttle class is used to oscillate between two translations.

A smooth transition between translation0 and translation1 is created using a cosine function. In the beginning of the cycle, translation0 is used. Halfway through the cycle, the resulting translation equals translation1, and at the end of the cycle, we're at translation0 again.

FILE FORMAT/DEFAULTS:

    Shuttle {
        translation 0 0 0
        translation0 0 0 0
        translation1 0 0 0
        speed 1
        on TRUE
    }

Constructor & Destructor Documentation

Constructor.

SoShuttle::~SoShuttle ( ) [protected, virtual]

Destructor.


Member Function Documentation

SoType SoShuttle::getClassTypeId ( void  ) [static]

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

Reimplemented from SoTranslation.

SoType SoShuttle::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 SoTranslation.

const SoFieldData ** SoShuttle::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 SoTranslation.

const SoFieldData * SoShuttle::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 SoTranslation.

void SoShuttle::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 SoTranslation.

void SoShuttle::write ( SoWriteAction action) [virtual]

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoNode.


Member Data Documentation

Translation at the start and end of the cycle. Default value is (0, 0, 0).

Translation at the middle of the cycle. Default value is (0, 0, 0).

Number of cycles per second. Default value is 1.

Toggles animation on or off. Defauls to TRUE.


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

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

Generated on Fri Dec 11 2015 03:25:20 for Coin by Doxygen 1.7.6.1.