'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SbPlaneProjector(3IV)
.SH NAME
SbPlaneProjector \(em plane projector 
.SH INHERITS FROM
SbProjector > SbPlaneProjector
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/projectors/SbPlaneProjector.h>
.sp
.in 1i
\f1Methods from class SbPlaneProjector:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSbPlaneProjector\*(Cr(SbBool orient = FALSE)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSbPlaneProjector\*(Cr(const SbPlane &plane, SbBool orient = FALSE)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SbPlaneProjector\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetPlane\*(Cr(const SbPlane &plane)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crconst SbPlane &
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetPlane\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetOrientToEye\*(Cr(SbBool orientToEye)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisOrientToEye\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbVec3f
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetVector\*(Cr(const SbVec2f &mousePosition1, const SbVec2f &mousePosition2)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbVec3f
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetVector\*(Cr(const SbVec2f &mousePosition)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetStartPosition\*(Cr(const SbVec2f &mousePosition)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetStartPosition\*(Cr(const SbVec3f &point)
.sp
.in 1i
\f1Methods from class SbProjector:
.in 0.5i
.sp
.ta 23m
.in 1i+23n
.ti 0.5i
.ta 23m
.ds Pt \*(Crvirtual SbVec3f
.ie \w'\*(Pt'>=23n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbproject\*(Cr(const SbVec2f &point)
.br
.in 1i+23n
.ti 0.5i
.ta 23m
.ds Pt \*(Crvirtual void
.ie \w'\*(Pt'>=23n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetViewVolume\*(Cr(const SbViewVolume &vol)
.br
.in 1i+23n
.ti 0.5i
.ta 23m
.ds Pt \*(Crconst SbViewVolume &
.ie \w'\*(Pt'>=23n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetViewVolume\*(Cr() const
.br
.in 1i+23n
.ti 0.5i
.ta 23m
.ds Pt \*(Crvirtual void
.ie \w'\*(Pt'>=23n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetWorkingSpace\*(Cr(const SbMatrix &space)
.br
.in 1i+23n
.ti 0.5i
.ta 23m
.ds Pt \*(Crconst SbMatrix &
.ie \w'\*(Pt'>=23n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetWorkingSpace\*(Cr() const
.br
.in 1i+23n
.ti 0.5i
.ta 23m
.ds Pt \*(Crvirtual SbProjector *
.ie \w'\*(Pt'>=23n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbcopy\*(Cr() const
.sp
.SH DESCRIPTION
\*(CbSbPlaneProjector\f1 projects the mouse onto a plane. This is typically used to write interactive 3D manipulators and viewers. 
.SH METHODS
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSbPlaneProjector\*(Cr(SbBool orient = FALSE)
.br
.in 1i
\f1Constructor. The default plane passes through the origin and is oriented perpendicular to the Z axis. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSbPlaneProjector\*(Cr(const SbPlane &plane, SbBool orient = FALSE)
.br
.in 1i
\f1Constructor which is passed a plane. If orient to eye is TRUE, the plane will be reoriented to the eye. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cb~SbPlaneProjector\*(Cr()
.br
.in 1i
\f1Destructor. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetPlane\*(Cr(const SbPlane &plane)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crconst SbPlane &
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetPlane\*(Cr() const
.br
.in 1i
\f1Set and get the plane to use. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetOrientToEye\*(Cr(SbBool orientToEye)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisOrientToEye\*(Cr() const
.br
.in 1i
\f1Set and get whether the projector should be oriented towards the eye. If \*(CborientToEye\f1 is set to TRUE, the given plane's direction is ignored, and the plane will be oriented to the eye. It will pass through the same
\&point from the origin defined by the original dir * dist. Set to FALSE if the plane's direction should remain in working space. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbVec3f
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetVector\*(Cr(const SbVec2f &mousePosition1, const SbVec2f &mousePosition2)
.br
.in 1i
\f1Get a vector on this plane given two normalized mouse positions. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbVec3f
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetVector\*(Cr(const SbVec2f &mousePosition)
.br
.in 1i
\f1Get a vector given the current mouse point. Uses the last point on this projector from the previous call to \*(CbgetVector()\f1 or \*(CbsetStartPostion()\f1.  Do not use this if the working space transform is changing since the new point will be in a
\&different space than the old one. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetStartPosition\*(Cr(const SbVec2f &mousePosition)
.br
.in 1i
\f1Set the initial mouse position. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetStartPosition\*(Cr(const SbVec3f &point)
.br
.in 1i
\f1Set the initial position from a point on the projector. 
.sp
.in 0.5i
.SH SEE ALSO
\*(CbSbCylinderProjector, SbCylinderPlaneProjector, SbCylinderSectionProjector, SbCylinderSheetProjector, SbLineProjector, SbSpherePlaneProjector, SbSphereProjector, SbSphereSectionProjector, SbSphereSheetProjector