SbCylinderProjector(3)

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

πŸ’– SbCylinderProjector(3) πŸ’–

okay bestie, welcome to the Coin library functions manual, and today's main character is SbCylinderProjector from Coin β€” yes, that Coin, the 3D toolkit one. buckle up πŸŽ€


✨ NAME ✨

SbCylinderProjector β€” the abstract base class for mapping to cylindrical surfaces. it's giving "parent class energy", fr fr πŸ’…


🌸 SYNOPSIS 🌸

#include <Inventor/projectors/SbCylinderProjector.h>

Inherits SbProjector.

Inherited by SbCylinderSectionProjector, and SbCylinderSheetProjector. so it's literally a whole family tree, iconic 🫢

🌈 Public Member Functions 🌈

  • virtual SbVec3f project (const SbVec2f &point)=0
  • SbVec3f projectAndGetRotation (const SbVec2f &point, SbRotation &rot)
  • virtual SbRotation getRotation (const SbVec3f &point1, const SbVec3f &point2)=0
  • void setCylinder (const SbCylinder &cyl)
  • const SbCylinder & getCylinder (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 void setViewVolume (const SbViewVolume &vol)
  • const SbViewVolume & getViewVolume (void) const
  • const SbMatrix & getWorkingSpace (void) const
  • virtual SbProjector * copy (void) const =0

πŸ¦‹ Protected Member Functions πŸ¦‹

  • SbCylinderProjector (const SbBool orienttoeye)
  • SbCylinderProjector (const SbCylinder &cylinder, const SbBool orienttoeye)
  • SbBool intersectCylinderFront (const SbLine &line, 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
  • SbCylinder cylinder
  • SbBool orientToEye
  • SbBool needSetup
  • SbVec3f lastPoint

🌸 Protected Attributes inherited from SbProjector

  • SbViewVolume viewVol
  • SbMatrix worldToWorking
  • SbMatrix workingToWorld

πŸ‘‘ Detailed Description πŸ‘‘

The SbCylinderProjector class is the abstract base class for mapping to cylindrical surfaces.

The cylinder projectors map 2D points to various surface types based on cylindrical shapes.

See also

  • SbSphereProjector

πŸŽ€ Constructor & Destructor Documentation πŸŽ€

SbCylinderProjector::SbCylinderProjector (const SbBool orienttoeye)

[protected]

Default constructor sets up a cylinder along the Y axis with height 1. cute lil starter cylinder, no cap 😌

References cylinder, intersectFront, needSetup, and orientToEye.

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

SbCylinderProjector::SbCylinderProjector (const SbCylinder & cylinder, const SbBool orienttoeye)

[protected]

Constructor taking an explicit cylinder projection definition. you get to say exactly what cylinder you want, periodt πŸ’…

References cylinder, intersectFront, needSetup, and orientToEye.


✨ Member Function Documentation ✨

virtual SbVec3f SbCylinderProjector::project (const SbVec2f & point)

[pure 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. yes bestie, normalized viewport coords β†’ 3D, and the type of projector decides the vibe 🌈

Implements SbProjector.

Implemented in SbCylinderPlaneProjector, SbCylinderSectionProjector, and SbCylinderSheetProjector.

References projectAndGetRotation().

Referenced by projectAndGetRotation().

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

Project the 2D point to a 3D coordinate on the cylindrical surface, and find the rotation from the last projection to this one. it's tracking where you were and how you got here, lowkey obsessed with continuity 🫢

See also

  • project(), getRotation()

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

Referenced by project().

virtual SbRotation SbCylinderProjector::getRotation (const SbVec3f & point1, const SbVec3f & point2)

[pure virtual]

Returns rotation on the projection surface which re-orients point1 to point2. glow-up from one point to another, slay ✨

Implemented in SbCylinderPlaneProjector, SbCylinderSectionProjector, and SbCylinderSheetProjector.

References cylinder, getCylinder(), intersectCylinderFront(), isFront(), isOrientToEye(), isPointInFront(), SbCylinderProjector(), setCylinder(), setFront(), and setOrientToEye().

Referenced by projectAndGetRotation().

void SbCylinderProjector::setCylinder (const SbCylinder & cylinderref)

Set cylinder to project onto. pick your cylinder, bestie 🎯

References cylinder, and needSetup.

Referenced by getRotation().

const SbCylinder & SbCylinderProjector::getCylinder (void ) const

Returns projection cylinder.

References cylinder.

Referenced by getRotation().

void SbCylinderProjector::setOrientToEye (const SbBool orienttoeye)

Sets whether or not the projection surface should be oriented towards the eye of the viewer. so like, should it face you? πŸ‘€ set the flag, decide the destiny.

References needSetup, and orientToEye.

Referenced by getRotation().

SbBool SbCylinderProjector::isOrientToEye (void ) const

Returns the state of the cylinder orientation flag.

References orientToEye.

Referenced by getRotation().

void SbCylinderProjector::setFront (const SbBool infront)

Set whether to intersect with the outside of the cylinder (isfront equal to TRUE), or the inside. outside = front cover, inside = backstage pass 🎟️

References intersectFront, and needSetup.

Referenced by getRotation().

SbBool SbCylinderProjector::isFront (void ) const

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

References intersectFront.

Referenced by getRotation(), and intersectCylinderFront().

SbBool SbCylinderProjector::isPointInFront (const SbVec3f & point) const

Check if point is on the frontside or the backside of the cylinder. vibe check for your point πŸ’…

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

Referenced by getRotation().

void SbCylinderProjector::setWorkingSpace (const SbMatrix & space)

[virtual]

Sets the matrix used for converting from the projector's coordinate system to the world coordinate system.

Reimplemented from SbProjector.

References needSetup, and SbProjector::setWorkingSpace().

SbBool SbCylinderProjector::intersectCylinderFront (const SbLine & line, SbVec3f & result)

[protected]

Intersect line with the SbCylinderProjector::cylinder and place the intersection point (if any) in result. Considers setFront() settings.

Returns TRUE if line actually hits the cylinder, FALSE if it doesn't intersect with it. no intersection, no problem, it just says FALSE 😭

References cylinder, and isFront().

Referenced by getRotation(), SbCylinderPlaneProjector::project(), SbCylinderSectionProjector::project(), and SbCylinderSheetProjector::project().


πŸ¦‹ Member Data Documentation πŸ¦‹

SbBool SbCylinderProjector::intersectFront

[protected]

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

Referenced by isFront(), SbCylinderProjector(), SbCylinderProjector(), setFront(), SbCylinderSheetProjector::setupPlane(), and SbCylinderSectionProjector::setupTolerance().

SbCylinder SbCylinderProjector::cylinder

[protected]

Specification of the projection cylinder.

Referenced by getCylinder(), SbCylinderPlaneProjector::getRotation(), getRotation(), SbCylinderSectionProjector::getRotation(), SbCylinderSheetProjector::getRotation(), intersectCylinderFront(), isPointInFront(), SbCylinderSectionProjector::project(), SbCylinderProjector(), SbCylinderProjector(), setCylinder(), SbCylinderSheetProjector::setupPlane(), and SbCylinderSectionProjector::setupTolerance().

SbBool SbCylinderProjector::orientToEye

[protected]

Which direction the cylindrical surface is oriented.

Referenced by isOrientToEye(), SbCylinderProjector(), SbCylinderProjector(), setOrientToEye(), SbCylinderSheetProjector::setupPlane(), and SbCylinderSectionProjector::setupTolerance().

SbBool SbCylinderProjector::needSetup

[protected]

Set to TRUE whenever the projection surface needs to be recalculated according to the setting of the SbCylinderProjector::orientToEye flag. it's the "bestie we need to redo this" flag πŸ”₯

Referenced by SbCylinderSectionProjector::isWithinTolerance(), SbCylinderPlaneProjector::project(), SbCylinderSectionProjector::project(), SbCylinderSheetProjector::project(), SbCylinderProjector(), SbCylinderProjector(), SbCylinderSectionProjector::SbCylinderSectionProjector(), SbCylinderSectionProjector::SbCylinderSectionProjector(), setCylinder(), setFront(), setOrientToEye(), SbCylinderSectionProjector::setTolerance(), SbCylinderSheetProjector::setupPlane(), SbCylinderSectionProjector::setupTolerance(), and setWorkingSpace().

SbVec3f SbCylinderProjector::lastPoint

[protected]

Stores the previously projected 3D point. it remembers where you last were, iconic memory-keeping behavior πŸ’œ

Referenced by SbCylinderPlaneProjector::project(), SbCylinderSectionProjector::project(), SbCylinderSheetProjector::project(), and projectAndGetRotation().


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code.


okay that's the whole thing bestie, every flag and every reference accounted for, no cap πŸ™ˆ and for the lil sign-off: this page came from Coin, Version 2.5.0, and it's the SbCylinderProjector(3) manual page. drink some water, hydrate, and go project some 2D points onto a cylinder πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from