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

								 SoAction(3IV)

NAME
     SoAction (SoAct) - abstract base class for all actions

INHERITS FROM
     SoAction

SYNOPSIS
     #include <Inventor_c/actions/SoAction.h>

     typedef SoAction	 SoAct

	  Functions from class SoAction:

     void		 SoActDelete(SoAct *this)
     void		 SoActApply(SoAct *this, SoNode *node)
     void		 SoActApplyPath(SoAct *this, SoPath *path)
     void		 SoActApplyPathList(SoAct *this, const SoPathList
			      *pathList, SbBool obeysRules = FALSE)
     SoType		 SoActGetClassTypeId()
     SoType		 SoActGetTypeId(SoAct *this)
     SbBool		 SoActIsOfType(SoAct *this, SoType type)
     void		 SoActInvalidateState(SoAct *this)

DESCRIPTION
     SoAction is the abstract base class for all actions. Classes derived from
     SoAction define operations to be applied at each node encountered during
     traversal of a scene graph. The function that gets called to implement
     the action for a particular node type is determined by a lookup table in
     the global database.

FUNCTIONS
     void		 SoActDelete(SoAct *this)
	  Destructor.

     void		 SoActApply(SoAct *this, SoNode *node)
     void		 SoActApplyPath(SoAct *this, SoPath *path)
     void		 SoActApplyPathList(SoAct *this, const SoPathList
			      *pathList, SbBool obeysRules = FALSE)
	  Initiates an action on the graph defined either by a node, path, or
	  list of paths. TRUE can be passed for the obeysRules flag if the
	  given path list has the following 4 properties:

	       1 - All paths have the same head node
	       2 - Paths are sorted in traversal order
	       3 - If one path ends at node A, no other path
		   continues through A
	       4 - No two paths are the same

	  These rules will be obeyed by path lists returned by picking and by
	  searches for non-group nodes.

Page 1

SoAction(3IV)

     SoType		 SoActGetClassTypeId()
	  Returns the type identifier for this class.

     SoType		 SoActGetTypeId(SoAct *this)
	  Returns the type identifier for a specific instance.

     SbBool		 SoActIsOfType(SoAct *this, SoType type)
	  Returns TRUE if this instance is of the type specified in type or is
	  derived from that type. Otherwise, it returns FALSE. For example,

	       SoActionIsOfType(actionPtr, SoGetMxActGetClassTypeId())

	  returns TRUE if actionPtr is an instance of SoGetMatrixAction or one
	  of its subclasses.

     void		 SoActInvalidateState(SoAct *this)
	  Invalidates the current traversal state in the action, forcing it to
	  be recreated when the action is next applied. This is typically
	  unnecessary in most applications.

SEE ALSO
     SoNode, SoPath, SoPathList, SoCallbackAction, SoGLRenderAction,
     SoGetBoundingBoxAction, SoGetMatrixAction, SoHandleEventAction,
     SoPickAction, SoRayPickAction, SoSearchAction, SoWriteAction

Page 2

Vote for polarhome