Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31559 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

								 SoEngine(3IV)

NAME
     SoEngine (SoEngine) - base class for all engines

INHERITS FROM
     SoBase > SoFieldContainer > SoEngine

SYNOPSIS
     #include <Inventor_c/engines/SoEngine.h>

	  Functions from class SoEngine:

     SoType		 SoEngineGetTypeId()
     int		 SoEngineGetOuts(const SoEngine *this,
			      SoEngineOutputList *list)
     SoEngineOutput *	 SoEngineGetOut(const SoEngine *this, const char
			      *outputName)
     SbBool		 SoEngineGetOutName(const SoEngine *this, const
			      SoEngineOutput *output, SbName *outputName)
     SoEngine *		 SoEngineCopy(const SoEngine *this)
     SoEngine *		 SoEngineGetByName(const char *name)
     int		 SoEngineGetByNameList(const char *name, SoEngineList
			      *list)

	  Functions from class SoFieldContainer:

     SoType		 SoEngineGetClassTypeId()
     void		 SoEngineSetToDflts(SoEngine *this)
     SbBool		 SoEngineHasDfltVals(const SoEngine *this)
     SbBool		 SoEngineFldsAreEq(const SoEngine *this, const
			      SoFieldContainer *fc)
     void		 SoEngineCopyFieldVals(SoEngine *this, const
			      SoFieldContainer *fc, SbBool copyConnections =
			      FALSE)
     SbBool		 SoEngineSet(SoEngine *this, const char
			      *fieldDataString)
     void		 SoEngineGet(SoEngine *this, SbString
			      *fieldDataString)
     int		 SoEngineGetFields(const SoEngine *this, SoFieldList
			      *resultList)
     SoField *		 SoEngineGetField(const SoEngine *this, const char
			      *fieldName)
     SbBool		 SoEngineGetFieldName(const SoEngine *this, const
			      SoField *field, SbName *fieldName)
     SbBool		 SoEngineIsNotifyEnabled(const SoEngine *this)
     SbBool		 SoEngineEnableNotify(SoEngine *this, SbBool flag)

	  Functions from class SoBase:

     void		 SoEngineRef(SoEngine *this)
     void		 SoEngineUnref(const SoEngine *this)
     void		 SoEngineUnrefNoDelete(const SoEngine *this)

Page 1

SoEngine(3IV)

     void		 SoEngineTouch(SoEngine *this)
     SbBool		 SoEngineIsOfType(const SoEngine *this, SoType type)
     void		 SoEngineSetName(SoEngine *this, const char *name)
     SbName		 SoEngineGetName(const SoEngine *this)

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.

FUNCTIONS
     SoType		 SoEngineGetTypeId()
	  Returns the type identifier for the SoEngine class.

     int		 SoEngineGetOuts(const SoEngine *this,
			      SoEngineOutputList *list)
	  Returns a list of outputs in this engine. Use getOutputName to get
	  the names of the outputs, and use  SoEngineOutputGetConnectionType
	  to determine their types.

     SoEngineOutput *	 SoEngineGetOut(const SoEngine *this, const char
			      *outputName)
	  Returns a pointer to the engine output with the given name. If no
	  such output exists, NULL is returned.

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

     SoEngine *		 SoEngineCopy(const SoEngine *this)
	  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).

     SoEngine *		 SoEngineGetByName(const char *name)
     int		 SoEngineGetByNameList(const char *name, SoEngineList
			      *list)
	  Look up engine(s) by name.

Page 2

								 SoEngine(3IV)

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

Page 3

Vote for polarhome