SbLineProjector(3)

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

πŸ’– SbLineProjector πŸ’–

okay bestie, welcome to the SbLineProjector(3) page, straight out of the Library Functions Manual ✨ this one's a Coin classic and honestly? it ate πŸ’…


🌸 NAME 🌸

SbLineProjector β€” the class that projects 2D points to 3D points along a line πŸ¦‹


✨ SYNOPSIS ✨

#include <Inventor/projectors/SbLineProjector.h>

Inherits SbProjector. (yes she's a nepo baby, but she earns it πŸ‘‘)

πŸŽ€ Public Member Functions

  • SbLineProjector (void)
  • virtual SbProjector * copy (void) const
  • virtual SbVec3f project (const SbVec2f &point)
  • virtual SbBool tryProject (const SbVec2f &point, const float epsilon, SbVec3f &result)
  • void setLine (const SbLine &line)
  • const SbLine & getLine (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)

πŸ’œ Public Member Functions inherited from SbProjector

  • virtual void setViewVolume (const SbViewVolume &vol)
  • const SbViewVolume & getViewVolume (void) const
  • virtual void setWorkingSpace (const SbMatrix &space)
  • const SbMatrix & getWorkingSpace (void) const

🌈 Protected Attributes

  • SbLine line
  • SbVec3f lastPoint

🌸 Protected Attributes inherited from SbProjector

  • SbViewVolume viewVol
  • SbMatrix worldToWorking
  • SbMatrix workingToWorld

🧚 Additional Inherited Members

πŸ“ 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

πŸ¦‹ Detailed Description πŸ¦‹

The SbLineProjector class projects 2D points to 3D points along a line. periodt πŸ’…

so the way that this works: when you hand her a 2D coordinate, the 3D projection she gives you back is constrained to lie along a pre-defined line. no wandering off, no main character detours, she stays on the line πŸ’–

ngl this is lowkey everywhere β€” you'll find it hanging out inside the translation draggers, like for instance SoTranslate1Dragger, where the whole vibe is moving "pieces" along one or more axes πŸ”₯


🌟 Constructor & Destructor Documentation 🌟

⭐ SbLineProjector::SbLineProjector (void )

Constructor πŸŽ€ Intializes the projector instance to use a line from <0, 0, 0> to <0, 1, 0>.

(no cap, that's the default, she comes pre-loaded 🫢)


πŸ’« Member Function Documentation πŸ’«

πŸ’– SbProjector * SbLineProjector::copy (void ) const [virtual]

Construct and return a copy of this projector. The caller is responsible for destructing the new instance. iykyk β€” you made the clone, you clean up the clone 🧹

⚠️ real talk, pay attention here: 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. πŸ’€ and when I say mysterious I mean the worst kind of mysterious, bestie. not the cute kind.

Implements SbProjector.

🌈 SbVec3f SbLineProjector::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.

πŸŽ€ SbBool SbLineProjector::tryProject (const SbVec2f & point, const float epsilon, SbVec3f & result) [virtual]

Try projecting the 2D point from normalized viewport coordinates to a 3D point πŸ’… The mapping will be done in accordance with the type of the projector.

If the projection can't be done safely (for instance when the projection plane or line is parallel to the view volume projection), this function should return FALSE. πŸ™ˆ

Default implementation will call project() and always return TRUE, but subclasses can override this behavior to support safe projections. so she's the chill default, and if you want more caution you go override her πŸ‘‘

Since

Coin 3.0

Reimplemented from SbProjector.

πŸ¦‹ void SbLineProjector::setLine (const SbLine & lineref)

Set a new projection line 🫢 3D points will be mapped to be on this line. yes queen, define your lane 🌸

πŸ“ const SbLine & SbLineProjector::getLine (void ) const

Returns the currently set projection line. πŸ‘€

⭐ SbVec3f SbLineProjector::getVector (const SbVec2f & viewpos1, const SbVec2f & viewpos2) [virtual]

Calculates and returns a vector between the projected 3D position of viewpos1 and viewpos2. two points in, one vector out, iconic ✨

πŸ’œ SbVec3f SbLineProjector::getVector (const SbVec2f & viewpos) [virtual]

Returns the 3D vector between the last projection and the one calculated for viewpos. she remembers the last one, she's thoughtful like that 😌

🧚 void SbLineProjector::setStartPosition (const SbVec2f & viewpos)

Explicitly set position of initial projection, so we get correct values for later calls to getVector() etc. 🎯

🌸 void SbLineProjector::setStartPosition (const SbVec3f & point)

Explicitly set position of initial projection, so we get correct values for later calls to getVector() etc. 🎯 (same energy, different argument type, we love an overload πŸ’…)


πŸ‘‘ Member Data Documentation πŸ‘‘

πŸ’« SbLine SbLineProjector::line [protected]

The projection line. Projected 3D points will be constrained to be on this line. she does not leave the line, fr fr πŸ¦‹

🌈 SbVec3f SbLineProjector::lastPoint [protected]

The last projected point. the receipts, basically 🧾


πŸŽ€ Author πŸŽ€

Generated automatically by Doxygen for Coin from the source code. not me being a Doxygen baby and still serving looks πŸ’…


okay that's the whole page bestie, you're so welcome πŸ’– and one last lil sign-off: this lil masterpiece is Coin, Version 3.1.3, and yes the footer really does just say SbLineProjector(3) down there, no date, she's mysterious like that ✨ go project something along a line, you're gonna slay πŸ«ΆπŸ‘‘

πŸ“¦ where this page comes from