NAME

       SbSphereSectionProjector -

       The SbSphereSectionProjector projects 2D points to a sliced sphere.

       The projection sphere for this class is sliced by a clipping plane. Projections will be
       mapped to the remaining sphere part.

SYNOPSIS

       #include <Inventor/projectors/SbSphereSectionProjector.h>

       Inherits SbSphereProjector.

       Inherited by SbSpherePlaneProjector.

   Public Member Functions
       SbSphereSectionProjector (const float edgetol=0.9f, const SbBool orienttoeye=TRUE)
       SbSphereSectionProjector (const SbSphere &sph, const float edgetol=0.9f, const SbBool
           orienttoeye=TRUE)
       virtual SbProjector * copy (void) const
       virtual SbVec3f project (const SbVec2f &point)
       virtual SbRotation getRotation (const SbVec3f &point1, const SbVec3f &point2)
       void setTolerance (const float edgetol)
       float getTolerance (void) const
       void setRadialFactor (const float rad=0.0f)
       float getRadialFactor (void) const
       SbBool isWithinTolerance (const SbVec3f &point)

   Protected Member Functions
       virtual void setupTolerance (void)

   Protected Attributes
       float tolerance
       float tolDist
       float radialFactor
       SbVec3f planePoint
       SbVec3f planeDir
       float planeDist
       SbPlane tolPlane

Detailed Description

       The SbSphereSectionProjector projects 2D points to a sliced sphere.

       The projection sphere for this class is sliced by a clipping plane. Projections will be
       mapped to the remaining sphere part.

       See Also:
           SbCylinderSectionProjector

Constructor & Destructor Documentation

   SbSphereSectionProjector::SbSphereSectionProjector (const floatedgetol = 0.9f, const
       SbBoolorienttoeye = TRUE)
       Default constructor. See SbSphereProjector::SbSphereProjector().

       The edgetol value should be within <0, 1], and specifies how much of the sphere is used as
       a projection surface. 1.0 means the full front half is used.

   SbSphereSectionProjector::SbSphereSectionProjector (const SbSphere &sph, const floatedgetol =
       0.9f, const SbBoolorienttoeye = TRUE)
       Constructor with explicit setting of the projection sphere.

Member Function Documentation

   SbProjector * SbSphereSectionProjector::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.

       Reimplemented in SbSpherePlaneProjector.

   SbVec3f SbSphereSectionProjector::project (const SbVec2f &point) [virtual]
       Project the 2D point from normalized viewport coordinates to a 3D point. The mapping will
       be done in accordance with the type of the projector.

       Implements SbProjector.

       Reimplemented in SbSpherePlaneProjector.

   SbRotation SbSphereSectionProjector::getRotation (const SbVec3f &point1, const SbVec3f
       &point2) [virtual]
       Returns rotation on the projection surface which re-orients point1 to point2.

       Implements SbSphereProjector.

       Reimplemented in SbSpherePlaneProjector.

   void SbSphereSectionProjector::setTolerance (const floatedgetol)
       The edgetol value decides how much of the surface of the sphere is used for projection.
       1.0 means the full sphere half is used.

   float SbSphereSectionProjector::getTolerance (void) const
       Returns edge tolerance for the sphere half.

   void SbSphereSectionProjector::setRadialFactor (const floatrad = 0.0f)
       Set up the controlling value for how the rotation calculation will be done 'outside' the
       sphere.

       A radialFactor equal to 0.0 will make the rotations be done like if they were done by
       dragging the sphere, while a value of 1.0 will make the rotation be around the axis from
       the viewpoint towards the sphere.

   float SbSphereSectionProjector::getRadialFactor (void) const
       Returns value of radialFactor.

       See Also:
           setRadialFactor()

   SbBool SbSphereSectionProjector::isWithinTolerance (const SbVec3f &point)
       Check if point is within the part of the sphere used for projections.

   void SbSphereSectionProjector::setupTolerance (void) [protected],  [virtual]
       Recalculate the internal projection surface settings. Needs to be done if any of the
       parameters influencing the projection surface have been changed from subclasses without
       using the access methods.

Member Data Documentation

   SbSphereSectionProjector::tolerance [protected]
       Tolerance value, deciding how much of the half-sphere to do projections against.

   SbSphereSectionProjector::tolDist [protected]
       Tolerance value multiplied with the sphere radius.

   SbSphereSectionProjector::radialFactor [protected]
       The radialfactor value decides how to calculate rotations outside of the sphere.

       See Also:
           setRadialFactor()

   SbSphereSectionProjector::planePoint [protected]
       A point in the plane where the center of the sphere is.

   SbSphereSectionProjector::planeDir [protected]
       Direction of cutting plane.

   SbSphereSectionProjector::planeDist [protected]
       Distance from plane to sphere center.

   SbSphereSectionProjector::tolPlane [protected]
       Defines the plane cutting the sphere into a projection part.

Author

       Generated automatically by Doxygen for Coin from the source code.