sbplaneprojector(3)
NAME
SbPlaneProjector
SYNOPSIS
#include <Inventor/projectors/SbPlaneProjector.h> Inherits SbProjector.
Detailed Description
The SbPlaneProjector class projects 2D points to 3D points in a plane.
The 3D projection of the 2D coordinates is for this projector class
constrained to lie inside a pre-defined 3D plane.
- See also:
- SbLineProjector
- Public Member Functions
- SbPlaneProjector (const SbBool orient=0)
SbPlaneProjector (const SbPlane &plane, const SbBool orient=0)
virtual SbProjector * copy (void) const
virtual SbVec3f project (const SbVec2f &point) void setPlane (const SbPlane &plane) const SbPlane & getPlane (void) const
void setOrientToEye (const SbBool orienttoeye) SbBool isOrientToEye (void) const
virtual SbVec3f getVector (const SbVec2f &viewpos1, const SbVec2f&viewpos2) - virtual SbVec3f getVector (const SbVec2f &viewpos) void setStartPosition (const SbVec2f &viewpos) void setStartPosition (const SbVec3f &point)
- Protected Member Functions
- void setupPlane (void)
- Protected Attributes
- SbPlane plane
SbPlane nonOrientPlane
SbBool orientToEye
SbBool needSetup
SbVec3f lastPoint
Constructor & Destructor Documentation
- SbPlaneProjector::SbPlaneProjector (const SbBool orient = 0)
- Constructor. Sets up a projection plane parallel with the XY-plane in
world coordinates. - Referenced by copy().
- SbPlaneProjector::SbPlaneProjector (const SbPlane & plane, const SbBool
- orient = 0)
Constructor taking an explicit projection plane definition.
Member Function Documentation
- SbProjector * SbPlaneProjector::copy (void) const [virtual]
- Construct and return a copy of this projector. The caller is
responsible for destructing the new instance. - Note that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you must make sure that both the Coin DLL and the application executable is using the same instance of a C Run-Time (CRT) library. Otherwise, you will get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes.
- Implements SbProjector.
- References SbPlaneProjector().
- SbVec3f SbPlaneProjector::project (const SbVec2f & point) [virtual]
- Projects 2D point into a 3D point within the current projection plane.
- Implements SbProjector.
- References SbProjector::findVanishingDistance(),
SbLine::getClosestPoints(), SbViewVolume::getDepth(),
SbLine::getDirection(), SbPlane::getDistance(),
SbViewVolume::getNearDist(), SbPlane::getNormal(),
SbViewVolume::getPlane(), SbLine::getPosition(),
SbViewVolume::getProjectionType(), SbProjector::getWorkingLine(),
SbPlane::intersect(), SbMatrix::multLineMatrix(),
SbMatrix::multVecMatrix(), needSetup, SbViewVolume::ORTHOGRAPHIC,
plane, SoDebugError::post(), setupPlane(), SbPlane::transform(),
SbProjector::verifyProjection(), SbProjector::viewVol,
SbProjector::workingToWorld, and SbProjector::worldToWorking. - Referenced by getVector(), and setStartPosition().
- void SbPlaneProjector::setPlane (const SbPlane & planeref)
- Set a new projection plane.
- References needSetup, nonOrientPlane, and plane.
- Referenced by SoVRMLPlaneSensor::~SoVRMLPlaneSensor().
- const SbPlane & SbPlaneProjector::getPlane (void) const
- Returns the current projection plane.
- References plane.
- void SbPlaneProjector::setOrientToEye (const SbBool orienttoeye)
- Sets whether or not the plane should always be oriented towards the
'eye' of the viewer. - References needSetup, and orientToEye.
- SbBool SbPlaneProjector::isOrientToEye (void) const
- Returns the state of the plane orientation flag.
- References orientToEye.
- SbVec3f SbPlaneProjector::getVector (const SbVec2f & viewpos1, const
- SbVec2f & viewpos2) [virtual] Returns a vector between the projected 3D points of viewpos1 and viewpos2.
- References lastPoint, and project().
- SbVec3f SbPlaneProjector::getVector (const SbVec2f & viewpos) [virtual]
- Returns a vector between the last projected point and the projected 3D point of viewpos.
- References lastPoint, and project().
- void SbPlaneProjector::setStartPosition (const SbVec2f & viewpos)
- Explicitly set position of initial projection, so we get correct values for later calls to getVector() etc.
- References lastPoint, and project().
- void SbPlaneProjector::setStartPosition (const SbVec3f & point)
- Explicitly set position of initial projection, so we get correct values for later calls to getVector() etc.
- References lastPoint.
- void SbPlaneProjector::setupPlane (void) [protected]
- Should be called whenever SbPlaneProjector::needSetup is TRUE. Will recalculate projection plane.
- References SbPlane::getDistanceFromOrigin(), SbPlane::getNormal(),
SbViewVolume::getProjectionDirection(), SbMatrix::multDirMatrix(),
needSetup, nonOrientPlane, orientToEye, plane, SbProjector::viewVol,
and SbProjector::worldToWorking. - Referenced by project().
Member Data Documentation
- SbPlaneProjector::plane [protected]
- The projection plane.
- Referenced by getPlane(), project(), setPlane(), and setupPlane().
- SbPlaneProjector::nonOrientPlane [protected]
- The 'original' plane which was set (as opposed to the recalculated
projection plane according to the SbPlaneProjector::orientToEye setting). - Referenced by setPlane(), and setupPlane().
- SbPlaneProjector::orientToEye [protected]
- Which direction the plane is oriented.
- Referenced by isOrientToEye(), setOrientToEye(), and setupPlane().
- SbPlaneProjector::needSetup [protected]
- Set to TRUE whenever the plane needs to be recalculated according to
the setting of the SbPlaneProjector::orientToEye flag. - Referenced by project(), setOrientToEye(), setPlane(), and
setupPlane(). - SbPlaneProjector::lastPoint [protected]
- Stores the previously projected 3D point.
- Referenced by getVector(), and setStartPosition().
Author
- Generated automatically by Doxygen for Coin from the source code.