SoXtPlaneViewer man page on IRIX

Man page or keyword search:  
man Server   31559 pages
apropos Keyword Search (all sections)
Output format
IRIX logo
[printable version]



							  SoXtPlaneViewer(3IV)

NAME
     SoXtPlaneViewer (SoXtPlnVwr) - viewer component which moves the camera in
     a plane

INHERITS FROM
     SoXtComponent > SoXtGLWidget > SoXtRenderArea > SoXtViewer >
     SoXtFullViewer > SoXtPlaneViewer

SYNOPSIS
     #include <Inventor_c/Xt/viewers/SoXtPlaneViewer.h>

     typedef SoXtPlaneViewer  SoXtPlnVwr

				   #define SoXtPlnVwrCreateStd(parent, name)
				   SoXtPlnVwrCreate(parent, name, TRUE,
				   SO_XT_FULL_VWR_BUILD_ALL,
				   SO_XT_VWR_BROWSER)

	  Functions from class SoXtPlaneViewer:

     SoXtPlaneViewer *	 SoXtPlnVwrCreate(Widget parent = NULL, const char
			      *name = NULL, SbBool buildInsideParent = TRUE,
			      SoXtFullViewer::BuildFlag flag = BUILD_ALL,
			      SoXtViewer::Type type = BROWSER)
     void		 SoXtPlnVwrDelete(SoXtPlnVwr *this)

	  Functions from class SoXtFullViewer:

     void		 SoXtPlnVwrSetDecor(SoXtPlnVwr *this, SbBool onOrOff)
     SbBool		 SoXtPlnVwrIsDecor(SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetPopupEnabled(SoXtPlnVwr *this, SbBool
			      trueOrFalse)
     SbBool		 SoXtPlnVwrIsPopupEnabled(SoXtPlnVwr *this)
     Widget		 SoXtPlnVwrGetAppPushBtnParent(const SoXtPlnVwr *this)
     void		 SoXtPlnVwrAddAppPushBtn(SoXtPlnVwr *this, Widget
			      newButton)
     void		 SoXtPlnVwrInsertAppPushBtn(SoXtPlnVwr *this, Widget
			      newButton, int index)
     void		 SoXtPlnVwrRemoveAppPushBtn(SoXtPlnVwr *this, Widget
			      oldButton)
     int		 SoXtPlnVwrFindAppPushBtn(SoXtPlnVwr *this, Widget
			      oldButton)
     int		 SoXtPlnVwrLengthAppPushBtn(SoXtPlnVwr *this)
     Widget		 SoXtPlnVwrGetRAWidget(SoXtPlnVwr *this)

	  Functions from class SoXtViewer:

     void		     SoXtPlnVwrSetCam(SoXtPlnVwr *this, SoCamera *cam)
     SoCamera *		     SoXtPlnVwrGetCam(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetCamType(SoXtPlnVwr *this, SoType
				  type)

Page 1

SoXtPlaneViewer(3IV)

     SoType		     SoXtPlnVwrGetCamType(SoXtPlnVwr *this)
     void		     SoXtPlnVwrViewAll(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSaveHomePos(SoXtPlnVwr *this)
     void		     SoXtPlnVwrResetToHomePos(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetHeadlight(SoXtPlnVwr *this, SbBool
				  onOrOff)
     SbBool		     SoXtPlnVwrIsHeadlight(SoXtPlnVwr *this)
     SoDirectionalLight *    SoXtPlnVwrGetHeadlight(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetDStyle(SoXtPlnVwr *this,
				  SoXtViewer::DrawType type,
				  SoXtViewer::DrawStyle style)
     SoXtViewer::DrawStyle   SoXtPlnVwrGetDStyle(SoXtPlnVwr *this,
				  SoXtViewer::DrawType type)
     void		     SoXtPlnVwrSetBufType(SoXtPlnVwr *this,
				  SoXtViewer::BufferType type)
     SoXtViewer::BufferType  SoXtPlnVwrGetBufType(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetViewing(SoXtPlnVwr *this, SbBool
				  onOrOff)
     SbBool		     SoXtPlnVwrIsViewing(const SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetCursorEnabled(SoXtPlnVwr *this,
				  SbBool onOrOff)
     SbBool		     SoXtPlnVwrIsCursorEnabled(const SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetAutoClip(SoXtPlnVwr *this, SbBool
				  onOrOff)
     SbBool		     SoXtPlnVwrIsAutoClip(const SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetStereoViewing(SoXtPlnVwr *this,
				  SbBool onOrOff)
     SbBool		     SoXtPlnVwrIsStereoViewing(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetStereoOffset(SoXtPlnVwr *this, float
				  dist)
     float		     SoXtPlnVwrGetStereoOffset(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetDtlSeek(SoXtPlnVwr *this, SbBool
				  onOrOff)
     SbBool		     SoXtPlnVwrIsDtlSeek(SoXtPlnVwr *this)
     void		     SoXtPlnVwrSetSeekTime(SoXtPlnVwr *this, float
				  seconds)
     float		     SoXtPlnVwrGetSeekTime(SoXtPlnVwr *this)
     void		     SoXtPlnVwrAddStartCB(SoXtPlnVwr *this,
				  SoXtViewerCB *f, void *userData = NULL)
     void		     SoXtPlnVwrAddFinishCB(SoXtPlnVwr *this,
				  SoXtViewerCB *f, void *userData = NULL)
     void		     SoXtPlnVwrRemoveStartCB(SoXtPlnVwr *this,
				  SoXtViewerCB *f, void *userData = NULL)
     void		     SoXtPlnVwrRemoveFinishCB(SoXtPlnVwr *this,
				  SoXtViewerCB *f, void *userData = NULL)
     void		     SoXtPlnVwrCopyView(SoXtPlnVwr *this, Time
				  eventTime)
     void		     SoXtPlnVwrPasteView(SoXtPlnVwr *this, Time
				  eventTime)
     void		     SoXtPlnVwrRecompSceneSiz(SoXtPlnVwr *this)

	  Functions from class SoXtRenderArea:

Page 2

							  SoXtPlaneViewer(3IV)

     void		       SoXtPlnVwrSetScene(SoXtPlnVwr *this, SoNode
				    *newScene)
     SoNode *		       SoXtPlnVwrGetScene(SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetOverScene(SoXtPlnVwr *this, SoNode
				    *newScene)
     SoNode *		       SoXtPlnVwrGetOverScene(SoXtPlnVwr *this)
     void		       SoXtPlnVwrRegisterDevice(SoXtPlnVwr *this,
				    SoXtDevice *)
     void		       SoXtPlnVwrUnregisterDevice(SoXtPlnVwr *this,
				    SoXtDevice *)
     void		       SoXtPlnVwrSetBkgCol(SoXtPlnVwr *this, const
				    SbColor *c)
     const SbColor *	       SoXtPlnVwrGetBkgCol(const SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetBkgInd(SoXtPlnVwr *this, int
				    index)
     int		       SoXtPlnVwrGetBkgInd(const SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetOverBkgInd(SoXtPlnVwr *this, int
				    index)
     int		       SoXtPlnVwrGetOverBkgInd(const SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetColMap(SoXtPlnVwr *this, int
				    startIndex, int num, const SbColor
				    *colors)
     void		       SoXtPlnVwrSetOverColMap(SoXtPlnVwr *this, int
				    startIndex, int num, const SbColor
				    *colors)
     void		       SoXtPlnVwrSetVPReg(SoXtPlnVwr *this, const
				    SbViewportRegion *newRegion)
     const SbViewportRegion *  SoXtPlnVwrGetVPReg(const SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetTranspType(SoXtPlnVwr *this,
				    SoGLRenderAction::TransparencyType type)
     SoGLRenderAction::TransparencyType
			       SoXtPlnVwrGetTranspType(const SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetAntialiasing(SoXtPlnVwr *this,
				    SbBool smoothing, int numPasses)
     void		       SoXtPlnVwrGetAntialiasing(const SoXtPlnVwr
				    *this, SbBool *smoothing, int *numPasses)
     void		       SoXtPlnVwrSetClearBeforeRender(SoXtPlnVwr
				    *this, SbBool trueOrFalse)
     SbBool		       SoXtPlnVwrIsClearBeforeRender(const SoXtPlnVwr
				    *this)
     void		       SoXtPlnVwrSetClearBeforeOverRender(SoXtPlnVwr
				    *this, SbBool trueOrFalse)
     SbBool		       SoXtPlnVwrIsClearBeforeOverRender(const
				    SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetAutoRedraw(SoXtPlnVwr *this,
				    SbBool trueOrFalse)
     SbBool		       SoXtPlnVwrIsAutoRedraw(const SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetRedrawPriority(SoXtPlnVwr *this,
				    uint32_t priority)
     uint32_t		       SoXtPlnVwrGetRedrawPriority(const SoXtPlnVwr
				    *this)

Page 3

SoXtPlaneViewer(3IV)

     uint32_t		       SoXtPlnVwrGetDefaultRedrawPriority()
     void		       SoXtPlnVwrRender(SoXtPlnVwr *this)
     void		       SoXtPlnVwrRenderOverlay(SoXtPlnVwr *this)
     void		       SoXtPlnVwrScheduleRedraw(SoXtPlnVwr *this)
     void		       SoXtPlnVwrScheduleOverRedraw(SoXtPlnVwr *this)
     void		       SoXtPlnVwrRedrawOnSelChange(SoXtPlnVwr *this,
				    SoSelection *s)
     void		       SoXtPlnVwrRedrawOverOnSelChange(SoXtPlnVwr
				    *this, SoSelection *s)
     void		       SoXtPlnVwrSetEvCB(SoXtPlnVwr *this,
				    SoXtRenderAreaEventCB *fcn, void *userData
				    = NULL)
     void		       SoXtPlnVwrSetGLRenderAct(SoXtPlnVwr *this,
				    SoGLRenderAction *ra)
     SoGLRenderAction *	       SoXtPlnVwrGetGLRenderAct(const SoXtPlnVwr
				    *this)
     void		       SoXtPlnVwrSetOverGLRenderAct(SoXtPlnVwr *this,
				    SoGLRenderAction *ra)
     SoGLRenderAction *	       SoXtPlnVwrGetOverGLRenderAct(const SoXtPlnVwr
				    *this)
     void		       SoXtPlnVwrSetSceneMgr(SoXtPlnVwr *this,
				    SoSceneManager *sm)
     SoSceneManager *	       SoXtPlnVwrGetSceneMgr(const SoXtPlnVwr *this)
     void		       SoXtPlnVwrSetOverSceneMgr(SoXtPlnVwr *this,
				    SoSceneManager *sm)
     SoSceneManager *	       SoXtPlnVwrGetOverSceneMgr(const SoXtPlnVwr
				    *this)

	  Functions from class SoXtGLWidget:

     void		 SoXtPlnVwrSetBorder(SoXtPlnVwr *this, SbBool onOrOff)
     SbBool		 SoXtPlnVwrIsBorder(const SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetDblBuf(SoXtPlnVwr *this, SbBool onOrOff)
     SbBool		 SoXtPlnVwrIsDblBuf(SoXtPlnVwr *this)
     Window		 SoXtPlnVwrGetNormWin(SoXtPlnVwr *this)
     Window		 SoXtPlnVwrGetOverWin(SoXtPlnVwr *this)
     GLXContext		 SoXtPlnVwrGetNormCtx(SoXtPlnVwr *this)
     GLXContext		 SoXtPlnVwrGetOverCtx(SoXtPlnVwr *this)
     Widget		 SoXtPlnVwrGetNormWidget(SoXtPlnVwr *this)
     Widget		 SoXtPlnVwrGetOverWidget(SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetNormVis(SoXtPlnVwr *this, XVisualInfo
			      *vis)
     XVisualInfo *	 SoXtPlnVwrGetNormVis(SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetOverVis(SoXtPlnVwr *this, XVisualInfo
			      *vis)
     XVisualInfo *	 SoXtPlnVwrGetOverVis(SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetDrwFrontBuf(SoXtPlnVwr *this, SbBool
			      enableFlag)
     SbBool		 SoXtPlnVwrIsDrwFrontBuf(const SoXtPlnVwr *this)

	  Functions from class SoXtComponent:

Page 4

							  SoXtPlaneViewer(3IV)

     void		 SoXtPlnVwrShow(SoXtPlnVwr *this)
     void		 SoXtPlnVwrHide(SoXtPlnVwr *this)
     SbBool		 SoXtPlnVwrIsVisible(SoXtPlnVwr *this)
     Widget		 SoXtPlnVwrGetWidget(const SoXtPlnVwr *this)
     SbBool		 SoXtPlnVwrIsTopLevelShell(const SoXtPlnVwr *this)
     Widget		 SoXtPlnVwrGetShellWidget(const SoXtPlnVwr *this)
     Widget		 SoXtPlnVwrGetParentWidget(const SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetSize(SoXtPlnVwr *this, const SbVec2s
			      *size)
     SbVec2s		 SoXtPlnVwrGetSize(SoXtPlnVwr *this)
     Display *		 SoXtPlnVwrGetDisplay(SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetTitle(SoXtPlnVwr *this, const char
			      *newTitle)
     const char *	 SoXtPlnVwrGetTitle(const SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetIconTitle(SoXtPlnVwr *this, const char
			      *newIconTitle)
     const char *	 SoXtPlnVwrGetIconTitle(const SoXtPlnVwr *this)
     void		 SoXtPlnVwrSetWinCloseCB(SoXtPlnVwr *this,
			      SoXtComponentCB *func, void *data = NULL)
     SoXtComponent *	 SoXtPlnVwrGetComp(Widget w)
     const char *	 SoXtPlnVwrGetWidgetName(const SoXtPlnVwr *this)
     const char *	 SoXtPlnVwrGetClassName(const SoXtPlnVwr *this)

DESCRIPTION
     The Plane viewer component allows the user to translate the camera in the
     viewing plane, as well as dolly (move foward/backward) and zoom in and
     out. The viewer also allows the user to roll the camera (rotate around
     the forward direction) and seek to objects which will specify a new
     viewing plane. This viewer could be used for modeling, in drafting, and
     architectural work. The camera can be aligned to the X, Y or Z axes.

FUNCTIONS
     SoXtPlaneViewer *	 SoXtPlnVwrCreate(Widget parent = NULL, const char
			      *name = NULL, SbBool buildInsideParent = TRUE,
			      SoXtFullViewer::BuildFlag flag = BUILD_ALL,
			      SoXtViewer::Type type = BROWSER)
     void		 SoXtPlnVwrDelete(SoXtPlnVwr *this)
	  Constructor and destructor which specifies the viewer type. Please
	  refer to the SoXtViewer man pages for a description of the viewer
	  types. For a constructor short cut look at the SoXtPlnVwrCreateStd
	  #define.

RESOURCES
	  *SoXtPlaneViewer.decoration: on (on | off)
	  *SoXtPlaneViewer.seekAnimationTime: 2.0 (float)
	  *SoXtPlaneViewer.seekTo: point (point | object)
	  *SoXtPlaneViewer.seekDistanceUsage: percentage (percentage | absolute)
	  *SoXtPlaneViewer.zoomMin: 1.0 (float)
	  *SoXtPlaneViewer.zoomMax: 179.0 (float)
	  *SoXtPlaneViewer.autoClipping: on (on | off)

Page 5

SoXtPlaneViewer(3IV)

	  *SoXtPlaneViewer.nearDistance: 2.4 (float, when autoClipping is off)
	  *SoXtPlaneViewer.farDistance: 2.8 (float, when autoClipping is off)
	  *SoXtPlaneViewer*BackgroundColor: black (color name or hex value)

USAGE
	  Left Mouse:
	  Left + Middle Mouse: Dolly in and out (gets closer to and further
	  away from the object).

	  Middle Mouse:
	  Ctrl + Left Mouse: Translate up, down, left and right.

	  Ctrl + Middle Mouse: Used for roll action (rotates around the viewer
	  forward direction).

	  <s> + click: Alternative to the Seek button. Press (but do not
	  hold down) the <s> key, then click on a target object.

	  Right Mouse: Open the popup menu.

SEE ALSO
     SoXtFullViewer, SoXtViewer, SoXtComponent, SoXtRenderArea,
     SoXtWalkViewer, SoXtExaminerViewer, SoXtFlyViewer

Page 6

[top]

List of man pages available for IRIX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net