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 | List of all members
SoPendulum Class Reference

The SoPendulum class is used to create oscillating rotations.A smooth transition between rotation0 and rotation1 is created using a cosine function. In the beginning of the cycle, rotation0 is used. Halfway through the cycle, the resulting rotation equals rotation1, and at the end of the cycle, we're at rotation0 again. More...

#include <Inventor/nodes/SoPendulum.h>

Inheritance diagram for SoPendulum:
SoRotation SoTransformation SoNode SoFieldContainer SoBase

Public Member Functions

virtual SoType getTypeId (void) const
 
 SoPendulum (void)
 
virtual void write (SoWriteAction *action)
 
- Public Member Functions inherited from SoRotation
 SoRotation (void)
 
virtual void doAction (SoAction *action)
 
virtual void GLRender (SoGLRenderAction *action)
 
virtual void callback (SoCallbackAction *action)
 
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
 
virtual void getMatrix (SoGetMatrixAction *action)
 
virtual void pick (SoPickAction *action)
 
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
 

Static Public Member Functions

static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoRotation
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoTransformation
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- 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 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)
 
static SoType getClassTypeId (void)
 
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 *in, SoBase *&base, SoType expectedtype)
 
static void setInstancePrefix (const SbString &c)
 
static void setTraceRefs (SbBool trace)
 
static SbBool getTraceRefs (void)
 
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
 
static SbBool readRoute (SoInput *in)
 

Public Attributes

SoSFRotation rotation0
 
SoSFRotation rotation1
 
SoSFFloat speed
 
SoSFBool on
 
- Public Attributes inherited from SoRotation
SoSFRotation rotation
 

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 
virtual ~SoPendulum ()
 
- Protected Member Functions inherited from SoRotation
virtual ~SoRotation ()
 
- Protected Member Functions inherited from SoTransformation
 SoTransformation (void)
 
virtual ~SoTransformation ()
 
- Protected Member Functions inherited from SoNode
 SoNode (void)
 
virtual ~SoNode ()
 
virtual SbBool readInstance (SoInput *in, unsigned short flags)
 
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 
 ~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
 

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoRotation
static const SoFieldData ** getFieldDataPtr (void)
 
- Static Protected Member Functions inherited from SoTransformation
static const SoFieldData ** getFieldDataPtr (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)
 

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
}
 
- Protected Types inherited from SoBase
enum  BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
 
- Protected Attributes inherited from SoNode
uint32_t uniqueId
 
- Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 0
 
static int nextActionMethodIndex = 0
 

Detailed Description

The SoPendulum class is used to create oscillating rotations.

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

FILE FORMAT/DEFAULTS:

Pendulum {
rotation 0 0 1 0
rotation0 0 0 1 0
rotation1 0 0 1 0
on TRUE
}

Constructor & Destructor Documentation

SoPendulum::SoPendulum ( void  )
SoPendulum::~SoPendulum ( )
protectedvirtual

Destructor.

References SoBase::unref().

Member Function Documentation

SoType SoPendulum::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
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)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 SoRotation.

const SoFieldData * SoPendulum::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 SoRotation.

void SoPendulum::write ( SoWriteAction action)
virtual

Action method for SoWriteAction.

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

Reimplemented from SoNode.

References SoWriteAction::getOutput(), SoOutput::getStage(), and SoNode::write().

Member Data Documentation

SoSFRotation SoPendulum::rotation0

The first rotation limit of the interpolation.

Referenced by SoPendulum().

SoSFRotation SoPendulum::rotation1

The other rotation limit of the interpolation.

Referenced by SoPendulum().

SoSFFloat SoPendulum::speed

Speed in cycles per second. Defaults to 1.

Referenced by SoPendulum().

SoSFBool SoPendulum::on

Toggles animation on or off. Defaults to being on.

Referenced by SoPendulum().


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

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

Generated on Thu Aug 15 2013 for Coin by Doxygen. 1.8.4