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

					      SoLineHighlightRenderAction(3IV)

NAME
     SoLineHighlightRenderAction (SoLineHLRenderAct) - selection highlight
     style

INHERITS FROM
     SoAction > SoGLRenderAction > SoLineHighlightRenderAction

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

     typedef SoLineHighlightRenderAction
			 SoLineHLRenderAct

	  Functions from class SoLineHighlightRenderAction:

     SoLineHighlightRenderAction *
			 SoLineHLRenderActCreate()
     void		 SoLineHLRenderActApply(SoLineHLRenderAct *this,
			      SoNode *node)
     void		 SoLineHLRenderActSetVisible(SoLineHLRenderAct *this,
			      SbBool b)
     SbBool		 SoLineHLRenderActIsVisible(const SoLineHLRenderAct
			      *this)
     void		 SoLineHLRenderActSetCol(SoLineHLRenderAct *this,
			      const SbColor *c)
     SbColor *		 SoLineHLRenderActGetCol(SoLineHLRenderAct *this)
     void		 SoLineHLRenderActSetLinePat(SoLineHLRenderAct *this,
			      unsigned short pattern)
     unsigned short	 SoLineHLRenderActGetLinePat(SoLineHLRenderAct *this)
     void		 SoLineHLRenderActSetLineWidth(SoLineHLRenderAct
			      *this, float width)
     float		 SoLineHLRenderActGetLineWidth(SoLineHLRenderAct
			      *this)

	  Functions from class SoGLRenderAction:

     void		       SoLineHLRenderActSetVPReg(SoLineHLRenderAct
				    *this, const SbViewportRegion *newRegion)
     const SbViewportRegion *  SoLineHLRenderActGetVPReg(const
				    SoLineHLRenderAct *this)
     void		       SoLineHLRenderActSetUpdateArea(SoLineHLRenderAct
				    *this, const SbVec2f *origin, const
				    SbVec2f *size)
     void		       SoLineHLRenderActGetUpdateArea(const
				    SoLineHLRenderAct *this, SbVec2f *origin,
				    SbVec2f *size)
     void		       SoLineHLRenderActSetAbortCB(SoLineHLRenderAct
				    *this, SoGLRenderAbortCB *func, void
				    *userData)
     void		       SoLineHLRenderActSetTranspType(SoLineHLRenderAct
				    *this, TransparencyType type)

Page 1

SoLineHighlightRenderAction(3IV)

     TransparencyType	       SoLineHLRenderActGetTranspType(const
				    SoLineHLRenderAct *this)
     void		       SoLineHLRenderActSetSmoothing(SoLineHLRenderAct
				    *this, SbBool smooth)
     SbBool		       SoLineHLRenderActIsSmoothing(const
				    SoLineHLRenderAct *this)
     void		       SoLineHLRenderActSetNumPasses(SoLineHLRenderAct
				    *this, int num)
     int		       SoLineHLRenderActGetNumPasses(const
				    SoLineHLRenderAct *this)
     void		       SoLineHLRenderActSetPassUpdate(SoLineHLRenderAct
				    *this, SbBool flag)
     SbBool		       SoLineHLRenderActIsPassUpdate(const
				    SoLineHLRenderAct *this)
     void		       SoLineHLRenderActSetPassCB(SoLineHLRenderAct
				    *this, SoGLRenderPassCB *func, void
				    *userData)
     void		       SoLineHLRenderActSetCacheContext(SoLineHLRenderAct
				    *this, uint32_t context)
     uint32_t		       SoLineHLRenderActGetCacheContext(const
				    SoLineHLRenderAct *this)

	  Functions from class SoAction:

     void		 SoLineHLRenderActApplyPath(SoLineHLRenderAct *this,
			      SoPath *path)
     void		 SoLineHLRenderActApplyPathList(SoLineHLRenderAct
			      *this, const SoPathList *pathList, SbBool
			      obeysRules = FALSE)
     SoType		 SoLineHLRenderActGetClassTypeId()
     SoType		 SoLineHLRenderActGetTypeId(SoLineHLRenderAct *this)
     SbBool		 SoLineHLRenderActIsOfType(SoLineHLRenderAct *this,
			      SoType type)
     void		 SoLineHLRenderActInvalidateState(SoLineHLRenderAct
			      *this)

DESCRIPTION
     SoLineHighlightRenderAction is a render action which renders the
     specified scene graph, then renders each selected object again in
     wireframe. Selected objects are specified by the first SoSelection node
     in the scene to which this action is applied. If there is no renderable
     geometry in a selected object, no highlight is rendered for that object.
     A highlight render action can be passed to SoXtRASetGLRenderAct() to have
     an affect on scene graphs.

FUNCTIONS
     SoLineHighlightRenderAction *
			 SoLineHLRenderActCreate()
	  Constructor.

Page 2

					      SoLineHighlightRenderAction(3IV)

     void		 SoLineHLRenderActApply(SoLineHLRenderAct *this,
			      SoNode *node)
	  This renders the passed scene graph, and also renders each selected
	  object in wireframe, as specified by the first SoSelection node
	  found in the scene graph.

     void		 SoLineHLRenderActSetVisible(SoLineHLRenderAct *this,
			      SbBool b)
	  This provides a convenient mechansim for turning highlights off or
	  back on. When FALSE is passed, subsequent calls to
	  SoLineHLRenderActApply() render the scene graph without rendering
	  highlights. The application is responsible for forcing a redraw of
	  the scene after changing this state. The default visibility is on.

     SbBool		 SoLineHLRenderActIsVisible(const SoLineHLRenderAct
			      *this)
	  Returns whether highlights will be rendered or not.

     void		 SoLineHLRenderActSetCol(SoLineHLRenderAct *this,
			      const SbColor *c)
     SbColor *		 SoLineHLRenderActGetCol(SoLineHLRenderAct *this)
	  Set and get the color of the highlight. Default is red (1,0,0). The
	  application is responsible for forcing a redraw of the scene to see
	  the affects of this change.

     void		 SoLineHLRenderActSetLinePat(SoLineHLRenderAct *this,
			      unsigned short pattern)
     unsigned short	 SoLineHLRenderActGetLinePat(SoLineHLRenderAct *this)
	  Set and get the line pattern of the highlight. Default is solid,
	  0xffff. The pattern of bits in the passed variable specifies the
	  pattern of the line. See SoDrawStyle for more information. The
	  application is responsible for forcing a redraw of the scene to see
	  the affects of this change.

     void		 SoLineHLRenderActSetLineWidth(SoLineHLRenderAct
			      *this, float width)
     float		 SoLineHLRenderActGetLineWidth(SoLineHLRenderAct
			      *this)
	  Set and get the line width of the highlight. Default is 3. The
	  application is responsible for forcing a redraw of the scene to see
	  the affects of this change.

EXAMPLE
     Here is an example of how a line highlight can be specified for a
     particular selection node and render area.

	      SoXtRenderArea *myRenderArea;
	      SoSelection *mySelection;

Page 3

SoLineHighlightRenderAction(3IV)

	      /* Set the highlight render action */
	      SoXtRASetGLRenderAct(myRenderArea,
		  (SoGLRenderAction *) SoLineHLRenderActCreate());

	      /* Automatic redraw on selection changes */
	      SoXtRARedrawOnSelChange(myRenderArea, mySelection);

SEE ALSO
     SoBoxHighlightRenderAction, SoGLRenderAction, SoSelection,
     SoXtRenderArea, SoDrawStyle, SoInteraction

Page 4

Vote for polarhome