SbSphereProjector(3)

πŸ“¦ version 2.5.0, in fedora 43, fedora 44

SbSphereProjector πŸ’–

okay bestie, gather round, because this is a manual page for SbSphereProjector(3) from the Library Functions Manual, and it's lowkey one of those abstract-base-class situations that sounds scary but is actually just vibes with math. sit down, grab a strawberry πŸ“, we're doing this.


✨ NAME ✨

SbSphereProjector β€” the abstract base class for mapping to spherical surfaces. she's the blueprint, the blueprint-est blueprint. everything else in this family is her daughter. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/projectors/SbSphereProjector.h>

Inherits SbProjector.

Inherited by SbSphereSectionProjector, and SbSphereSheetProjector.

🌸 Public Member Functions 🌸

  • SbVec3f projectAndGetRotation(const SbVec2f &point, SbRotation &rot)
  • virtual SbRotation getRotation(const SbVec3f &point1, const SbVec3f &point2) = 0
  • void setSphere(const SbSphere &sph)
  • const SbSphere & getSphere(void) const
  • void setOrientToEye(const SbBool orienttoeye)
  • SbBool isOrientToEye(void) const
  • void setFront(const SbBool infront)
  • SbBool isFront(void) const
  • SbBool isPointInFront(const SbVec3f &point) const
  • virtual void setWorkingSpace(const SbMatrix &space)

πŸ’œ Public Member Functions inherited from SbProjector

  • virtual SbVec3f project(const SbVec2f &point) = 0
  • virtual void setViewVolume(const SbViewVolume &vol)
  • const SbViewVolume & getViewVolume(void) const
  • const SbMatrix & getWorkingSpace(void) const
  • virtual SbProjector * copy(void) const = 0

πŸŽ€ Protected Member Functions πŸŽ€

  • SbSphereProjector(const SbBool orienttoeye)
  • SbSphereProjector(const SbSphere &s, const SbBool orienttoeye)
  • SbBool intersectSphereFront(const SbLine &l, SbVec3f &result)

πŸ’œ Protected Member Functions inherited from SbProjector

  • SbProjector(void)
  • virtual ~SbProjector()
  • SbLine getWorkingLine(const SbVec2f &point) const
  • float findVanishingDistance(void) const
  • SbBool verifyProjection(const SbVec3f &projpt) const

🌈 Protected Attributes 🌈

  • SbBool intersectFront
  • SbSphere sphere
  • SbBool orientToEye
  • SbBool needSetup
  • SbVec3f lastPoint

πŸ’œ Protected Attributes inherited from SbProjector

  • SbViewVolume viewVol
  • SbMatrix worldToWorking
  • SbMatrix workingToWorld

πŸ‘‘ Detailed Description πŸ‘‘

The SbSphereProjector class is the abstract base class for mapping to spherical surfaces.

The sphere projectors map 2D points to various surface types based on spherical shapes. that's the whole gig. 2D in, sphere-y 3D out, no cap. 🫢

See also

  • SbCylinderProjector

🧚 Constructor & Destructor Documentation 🧚

🌟 SbSphereProjector::SbSphereProjector(const SbBool orienttoeye) [protected]

Default constructor sets up a sphere at the origin with radius 1. cute, simple, iconic. πŸ’«

References intersectFront, lastPoint, needSetup, orientToEye, and sphere.

Referenced by getRotation(), SbSphereSheetProjector::SbSphereSheetProjector(), and SbSphereSheetProjector::SbSphereSheetProjector().

🌟 SbSphereProjector::SbSphereProjector(const SbSphere & s, const SbBool orienttoeye) [protected]

Constructor taking an explicit sphere projection definition. you bring the sphere, she brings the projection. ✨

References intersectFront, lastPoint, needSetup, orientToEye, and sphere.


πŸ’… Member Function Documentation πŸ’…

🌸 SbVec3f SbSphereProjector::projectAndGetRotation(const SbVec2f & point, SbRotation & rot)

Project the 2D point to a 3D coordinate on the spherical surface, and find the rotation from the last projection to this one. so she remembers where you were last time and tells you how to spin to where you are now. main character energy fr. πŸ”₯

See also

  • project(), getRotation()

References getRotation(), lastPoint, and SbProjector::project().

🌸 virtual SbRotation SbSphereProjector::getRotation(const SbVec3f & point1, const SbVec3f & point2) [pure virtual]

Returns rotation on the projection surface which re-orients point1 to point2. pure virtual, bestie β€” you literally cannot instantiate this one, the subclasses have to do the work. πŸ‘‘

Implemented in SbSpherePlaneProjector, SbSphereSectionProjector, and SbSphereSheetProjector.

References getSphere(), intersectSphereFront(), isFront(), isOrientToEye(), isPointInFront(), SbSphereProjector(), setFront(), setOrientToEye(), and setSphere().

Referenced by projectAndGetRotation().

🌸 void SbSphereProjector::setSphere(const SbSphere & sph)

Set sphere to project onto. pick your sphere, girl. 🌐

References needSetup, and sphere.

Referenced by getRotation().

🌸 const SbSphere & SbSphereProjector::getSphere(void) const

Returns projection sphere.

References sphere.

Referenced by getRotation().

🌸 void SbSphereProjector::setOrientToEye(const SbBool orienttoeye)

Sets whether or not the projection surface should be oriented towards the eye of the viewer. Default is TRUE. πŸ‘οΈβœ¨

References needSetup, and orientToEye.

Referenced by getRotation().

🌸 SbBool SbSphereProjector::isOrientToEye(void) const

Returns the state of the sphere orientation flag. yes/no, do we face the eyeballs. πŸ™ˆ

References orientToEye.

Referenced by getRotation(), and SbSphereSheetProjector::project().

🌸 void SbSphereProjector::setFront(const SbBool infront)

Set whether to intersect with the outside of the sphere (infront equal to TRUE), or the inside. outside girlie or inside girlie, choose your fighter. πŸ’–

References intersectFront, and needSetup.

Referenced by getRotation().

🌸 SbBool SbSphereProjector::isFront(void) const

Returns value of the flag which decides whether to intersect with the outside or inside of the sphere.

References intersectFront.

Referenced by getRotation(), and intersectSphereFront().

🌸 SbBool SbSphereProjector::isPointInFront(const SbVec3f & point) const

Check if point is on the frontside or the backside of the cylinder. 🫠 okay so the docs literally say "cylinder" here even though this whole class is about spheres β€” that's what the page says, so that's what you get. we do not edit the source, we only love her.

References SbVec3f::dot(), SbViewVolume::getProjectionPoint(), SbViewVolume::getProjectionType(), SbProjector::getViewVolume(), SbViewVolume::PERSPECTIVE, sphere, SbProjector::worldToWorking, and SbViewVolume::zVector().

Referenced by getRotation().

🌸 void SbSphereProjector::setWorkingSpace(const SbMatrix & space) [virtual]

Sets the matrix used for converting from the projector's coordinate system to the world coordinate system. coordinate system glow-up. 🌍➑️🏠

Reimplemented from SbProjector.

References needSetup, and SbProjector::setWorkingSpace().

πŸŽ€ SbBool SbSphereProjector::intersectSphereFront(const SbLine & l, SbVec3f & result) [protected]

Intersect line l with the SbSphereProjector::sphere and place the intersection point (if any) in result. Considers setFront() settings.

Returns TRUE if line actually hits the sphere, FALSE if it doesn't intersect with it. so basically: did the line make it? πŸ’€

References isFront(), and sphere.

Referenced by getRotation(), SbSpherePlaneProjector::project(), SbSphereSectionProjector::project(), and SbSphereSheetProjector::project().


πŸ“ Member Data Documentation πŸ“

⭐ SbBool SbSphereProjector::intersectFront [protected]

Flag which says whether or not we should map to the outside or inside of the sphere surface.

Referenced by isFront(), SbSphereSheetProjector::project(), SbSphereProjector(), SbSphereProjector(), setFront(), SbSphereSheetProjector::setupPlane(), and SbSphereSectionProjector::setupTolerance().

⭐ SbSphere SbSphereProjector::sphere [protected]

Projection sphere. literally the sphere. 🫢

Referenced by SbSpherePlaneProjector::getRotation(), SbSphereSectionProjector::getRotation(), getSphere(), intersectSphereFront(), isPointInFront(), SbSphereSectionProjector::project(), SbSphereSheetProjector::project(), SbSphereProjector(), SbSphereProjector(), setSphere(), SbSphereSheetProjector::setupPlane(), and SbSphereSectionProjector::setupTolerance().

⭐ SbBool SbSphereProjector::orientToEye [protected]

Which direction the spherical surface is oriented.

Referenced by isOrientToEye(), SbSphereProjector(), SbSphereProjector(), setOrientToEye(), SbSphereSheetProjector::setupPlane(), and SbSphereSectionProjector::setupTolerance().

⭐ SbBool SbSphereProjector::needSetup [protected]

Set to TRUE whenever the projection surface needs to be recalculated according to the setting of the SbSphereProjector::orientToEye flag. the "girl we need to redo this" flag. πŸ’…

Referenced by SbSphereSheetProjector::getRotation(), SbSphereSectionProjector::isWithinTolerance(), SbSpherePlaneProjector::project(), SbSphereSectionProjector::project(), SbSphereSheetProjector::project(), SbSphereProjector(), SbSphereProjector(), setFront(), setOrientToEye(), setSphere(), SbSphereSectionProjector::setTolerance(), SbSphereSheetProjector::setupPlane(), SbSphereSectionProjector::setupTolerance(), and setWorkingSpace().

⭐ SbVec3f SbSphereProjector::lastPoint [protected]

Stores the previously projected 3D point. her memory of the last place you were. 😭 iconic behaviour honestly.

Referenced by SbSpherePlaneProjector::project(), SbSphereSectionProjector::project(), SbSphereSheetProjector::project(), projectAndGetRotation(), SbSphereProjector(), and SbSphereProjector().


🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. yes bestie, a robot wrote the original and now a robot wrote this one. we're all just vibes in a machine. πŸ€–βœ¨


okay and that's the whole page, no skips, no skimming, every single option and cross-reference accounted for. πŸ’–

tiny sign-off for the footer: this page lives in Coin, Version 2.5.0, and it's filed under SbSphereProjector(3). periodt. πŸŽ€πŸ¦‹
πŸ“¦ where this page comes from