Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SbPlaneProjector(3IV)()				       SbPlaneProjector(3IV)()

NAME
       SbPlaneProjector	-- plane projector

INHERITS FROM
       SbProjector > SbPlaneProjector

SYNOPSIS
       #include	<Inventor/projectors/SbPlaneProjector.h>

	  Methods from class SbPlaneProjector:

			 SbPlaneProjector(SbBool orient	= FALSE)
			 SbPlaneProjector(const	 SbPlane &plane, SbBool	orient
			      =	FALSE)
			 ~SbPlaneProjector()
     void		 setPlane(const	SbPlane	&plane)
     const SbPlane &	 getPlane() const
     void		 setOrientToEye(SbBool orientToEye)
     SbBool		 isOrientToEye() const
     virtual SbVec3f	 getVector(const SbVec2f  &mousePosition1,  const  Sb-
			      Vec2f &mousePosition2)
     virtual SbVec3f	 getVector(const SbVec2f &mousePosition)
     void		 setStartPosition(const	SbVec2f	&mousePosition)
     void		 setStartPosition(const	SbVec3f	&point)

	  Methods from class SbProjector:

     virtual SbVec3f	    project(const SbVec2f &point)
     virtual void	    setViewVolume(const	SbViewVolume &vol)
     const SbViewVolume	&   getViewVolume() const
     virtual void	    setWorkingSpace(const SbMatrix &space)
     const SbMatrix &	    getWorkingSpace() const
     virtual SbProjector *  copy() const

DESCRIPTION
       SbPlaneProjector	 projects  the	mouse  onto a plane. This is typically
       used to write interactive 3D manipulators and viewers.

METHODS
			 SbPlaneProjector(SbBool orient	= FALSE)
	  Constructor. The default plane passes	through	the origin and is ori-
	  ented	perpendicular to the Z axis.

			 SbPlaneProjector(const	 SbPlane &plane, SbBool	orient
			      =	FALSE)
	  Constructor which is passed a	plane. If orient to eye	is  TRUE,  the
	  plane	will be	reoriented to the eye.

			 ~SbPlaneProjector()
	  Destructor.

     void		 setPlane(const	SbPlane	&plane)
     const SbPlane &	 getPlane() const
	  Set and get the plane	to use.

     void		 setOrientToEye(SbBool orientToEye)
     SbBool		 isOrientToEye() const
	  Set  and  get	 whether  the projector	should be oriented towards the
	  eye. If orientToEye 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.

     virtual SbVec3f	 getVector(const SbVec2f  &mousePosition1,  const  Sb-
			      Vec2f &mousePosition2)
	  Get a	vector on this plane given two normalized mouse	positions.

     virtual SbVec3f	 getVector(const SbVec2f &mousePosition)
	  Get  a  vector given the current mouse point.	Uses the last point on
	  this projector from the previous call	to getVector() or setStartPos-
	  tion().   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.

     void		 setStartPosition(const	SbVec2f	&mousePosition)
	  Set the initial mouse	position.

     void		 setStartPosition(const	SbVec3f	&point)
	  Set the initial position from	a point	on the projector.

FILE FORMAT/DEFAULTS
SEE ALSO
       SbCylinderProjector, SbCylinderPlaneProjector, SbCylinderSectionProjec-
       tor, SbCylinderSheetProjector, SbLineProjector, SbSpherePlaneProjector,
       SbSphereProjector, SbSphereSectionProjector, SbSphereSheetProjector

						       SbPlaneProjector(3IV)()

NAME | INHERITS FROM | SYNOPSIS | DESCRIPTION | METHODS | FILE FORMAT/DEFAULTS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=SbPlaneProjector&sektion=3iv&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help