GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOENGINE (3)

NAME

SoEngine — base class for all engines

CONTENTS

Inherits From
Synopsis
Description
Methods
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoEngine

SYNOPSIS

#include <Inventor/engines/SoEngine.h>

Methods from class SoEngine:

    static SoType    
                    
static SoType        getClassTypeId()    
virtual int    
                    
virtual int          getOutputs(SoEngineOutputList &list) const    
SoEngineOutput *    
                    
SoEngineOutput *     getOutput(const SbName &outputName) const    
SbBool    
                    
SbBool               getOutputName(const SoEngineOutput *output, SbName &outputName) const    
SoEngine *    
                    
SoEngine *           copy() const    
static SoEngine *    
                    
static SoEngine *    getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoEngineList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
SbBool    
                    
SbBool               set(const char *fieldDataString)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

DESCRIPTION

SoEngine is the abstract base class for all engines. Engines are objects used for animation and behavior. They are lightweight objects that are connected between nodes, the clock, and other engines to form interesting behaviorial objects (e.g., a spinning windmill).

Engines are used to animate parts of a scene and/or to constrain one part of a scene in relation to some other part of the scene. An engine receives a number of input values, performs some operation on them, and then copies the results into one or more output fields. Both the inputs and the outputs can be connected to other fields or engines in the scene graph. When an engine’s output values change, those new values are sent to any fields or engines connected to them.

METHODS

    static SoType    
                    
static SoType        getClassTypeId()
Returns the type identifier for the SoEngine class.

    virtual int    
                    
virtual int          getOutputs(SoEngineOutputList &list) const
Returns a list of outputs in this engine. Use getOutputName to get the names of the outputs, and use SoEngineOutput::getConnectionType to determine their types.

    SoEngineOutput *    
                    
SoEngineOutput *     getOutput(const SbName &outputName) const
Returns a pointer to the engine output with the given name. If no such output exists, NULL is returned.

    SbBool    
                    
SbBool               getOutputName(const SoEngineOutput *output, SbName &outputName) const
Returns (in outputName) the name of the engine output (output). Returns FALSE if the engine output is not contained within the engine instance.

    SoEngine *    
                    
SoEngine *           copy() const
Creates and returns an exact copy of the engine. All connections to inputs are copied as is (without copying what’s at the other end).

    static SoEngine *    
                    
static SoEngine *    getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoEngineList &list)
Look up engine(s) by name.

FILE FORMAT/DEFAULTS

This is an abstract class. See the reference page of a derived class for the format and default values.

SEE ALSO

SoBoolOperation, SoCalculator, SoComposeMatrix, SoComposeRotation, SoComposeRotationFromTo, SoComposeVec2f, SoComposeVec3f, SoComposeVec4f, SoComputeBoundingBox, SoConcatenate, SoCounter, SoDecomposeMatrix, SoDecomposeRotation, SoDecomposeVec2f, SoDecomposeVec3f, SoDecomposeVec4f, SoElapsedTime, SoGate, SoInterpolate, SoOnOff, SoOneShot, SoSelectOne, SoTimeCounter, SoTransformVec3f, SoTriggerAny

Search for    or go to Top of page |  Section 3 |  Main Index


SOENGINE(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.