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

								SoShuttle(3IV)

NAME
     SoShuttle (SoShuttle) - animated oscillating translation node

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoTransformation > SoTranslation >
     SoShuttle

SYNOPSIS
     #include <Inventor_c/nodes/SoShuttle.h>

	  Fields from class SoShuttle:

     SoSFVec3f		 translation0
     SoSFVec3f		 translation1
     SoSFFloat		 speed
     SoSFBool		 on

	  Fields from class SoTranslation:

     SoSFVec3f		 translation

	  Functions from class SoShuttle:

     SoShuttle *	 SoShuttleCreate()
     SoType		 SoShuttleGetClassTypeId()

	  Functions from class SoNode:

     void		 SoShuttleSetOverride(SoShuttle *this, SbBool state)
     SbBool		 SoShuttleIsOverride(const SoShuttle *this)
     SoNode *		 SoShuttleCopy(const SoShuttle *this, SbBool
			      copyConnections = FALSE)
     SbBool		 SoShuttleAffectsState(const SoShuttle *this)
     SoNode *		 SoShuttleGetByName(const char *name)
     int		 SoShuttleGetByNameList(const char *name, SoNodeList
			      *list)

	  Functions from class SoFieldContainer:

     void		 SoShuttleSetToDflts(SoShuttle *this)
     SbBool		 SoShuttleHasDfltVals(const SoShuttle *this)
     SbBool		 SoShuttleFldsAreEq(const SoShuttle *this, const
			      SoFieldContainer *fc)
     void		 SoShuttleCopyFieldVals(SoShuttle *this, const
			      SoFieldContainer *fc, SbBool copyConnections =
			      FALSE)
     SbBool		 SoShuttleSet(SoShuttle *this, const char
			      *fieldDataString)
     void		 SoShuttleGet(SoShuttle *this, SbString
			      *fieldDataString)
     int		 SoShuttleGetFields(const SoShuttle *this, SoFieldList
			      *resultList)

Page 1

SoShuttle(3IV)

     SoField *		 SoShuttleGetField(const SoShuttle *this, const char
			      *fieldName)
     SbBool		 SoShuttleGetFieldName(const SoShuttle *this, const
			      SoField *field, SbName *fieldName)
     SbBool		 SoShuttleIsNotifyEnabled(const SoShuttle *this)
     SbBool		 SoShuttleEnableNotify(SoShuttle *this, SbBool flag)

	  Functions from class SoBase:

     void		 SoShuttleRef(SoShuttle *this)
     void		 SoShuttleUnref(const SoShuttle *this)
     void		 SoShuttleUnrefNoDelete(const SoShuttle *this)
     void		 SoShuttleTouch(SoShuttle *this)
     SoType		 SoShuttleGetTypeId(const SoShuttle *this)
     SbBool		 SoShuttleIsOfType(const SoShuttle *this, SoType type)
     void		 SoShuttleSetName(SoShuttle *this, const char *name)
     SbName		 SoShuttleGetName(const SoShuttle *this)

DESCRIPTION
     The SoShuttle class is derived from SoTranslation, so it applies a
     translation to the current transformation. Using engines connected to the
     realTime global field, the translation value is animated over time
     between two fixed translations, achieving a shuttling effect. The period
     of the motion can be adjusted by changing the speed field. The current
     translation at any time is available in the translation field, inherited
     from SoTranslation

FIELDS
     SoSFVec3f		 translation0
     SoSFVec3f		 translation1
	  These define the two fixed translations that are interpolated to
	  create the shuttling motion.

     SoSFFloat		 speed
	  Defines the speed of the shuttle, in cycles per second.

     SoSFBool		 on
	  Allows applications to enable or disable the motion easily.

FUNCTIONS
     SoShuttle *	 SoShuttleCreate()
	  Creates a shuttle node with default settings.

     SoType		 SoShuttleGetClassTypeId()
	  Returns type identifier for this class.

ACTION BEHAVIOR
     SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction,
     SoRayPickAction

Page 2

								SoShuttle(3IV)

	  Concatenates interpolated translation value with the current
	  transformation matrix.

     SoGetMatrixAction
	  Returns transformation matrix specified by the interpolated
	  translation.

FILE FORMAT/DEFAULTS
     Shuttle {
	  translation	0 0 0
	  translation0	0 0 0
	  translation1	0 0 0
	  speed		1
	  on		TRUE
     }

SEE ALSO
     SoPendulum, SoRotor

Page 3

Vote for polarhome