SbLine(3)

📦 version 3.1.3, in fedora 43, fedora 44

💫 SbLine — the SbLine(3) manual page, bestie edition 💫

okay so real quick: this is from the Library Functions Manual, and it's literally all about the SbLine class. she's a 3D line. that's it. that's the girl. 🎀

✨ NAME ✨

SbLine — the SbLine class represents a line in 3D space. no cap, that's the whole job description. 👑

🌸 SYNOPSIS 🌸

#include <Inventor/SbLinear.h>

🦋 Public Member Functions

  • SbLine (void)
  • SbLine (const SbVec3f &origin, const SbVec3f &point)
  • void setValue (const SbVec3f &origin, const SbVec3f &point)
  • SbBool getClosestPoints (const SbLine &line2, SbVec3f &ptOnThis, SbVec3f &ptOnLine2) const
  • SbVec3f getClosestPoint (const SbVec3f &point) const
  • const SbVec3f & getPosition (void) const
  • const SbVec3f & getDirection (void) const
  • void print (FILE *file) const

💅 Detailed Description 💅

so, the SbLine class represents a line in 3D space. iconic of her honestly.

SbLine gives you a way of specifying a directed line, through a 3D point (the origin) and a vector direction in 3D space. ✨

and here's the vibe check you need to pass: it is context dependent whether or not an SbLine counts as a ray — extending from the starting point in only one direction — or as a line that intersects the origin point and extends infinitely from it in both directions. so like... she contains multitudes. 🫶

SbLine is used by many other classes in Coin. she's everywhere, she's booked and busy. 💜

👀 See also

  • SbVec3f

🧚 Constructor & Destructor Documentation 🧚

🍓 SbLine::SbLine (void )

the default constructor does nothing. like literally nothing. the line will be uninitialized until the first assignment or setValue() call. so don't come for her before she's ready bestie 😭

🌈 SbLine::SbLine (const SbVec3f & origin, const SbVec3f & point)

constructor where origin specifies the line origin point, and point specifies another point on the line that is used to determine the line's direction.

⚠️ point should not be the same as origin, because that leads to the line having a null vector as the direction vector. and that will cause division by zero problems in some of the other methods on this class. so don't do it fr fr 💀

also be aware: the direction vector will be normalized and will not be the same as point - origin. she's been through the glow-up filter, okay?

👀 See also

  • setValue, getOrigin, getDirection

🔥 Member Function Documentation 🔥

💖 void SbLine::setValue (const SbVec3f & origin, const SbVec3f & point)

set a new position and direction for the line by specifying the line origin and another point on the line that is used to determine the line's direction.

⚠️ same warning, same energy: point should not be the same as origin, because that leads to having a null vector as the direction vector. and that will cause division by zero problems in some of the other methods on this class. ma'am please. 🙈

be aware that the direction vector will be normalized and will not be the same as point - origin.

👀 See also

  • setValue, getOrigin, getDirection

⭐ SbBool SbLine::getClosestPoints (const SbLine & line2, SbVec3f & ptOnThis, SbVec3f & ptOnLine2) const

returns the two closest points on the lines. here's the tea:

  • if the lines are parallel, all points are equally close and we return FALSE.
  • if the lines are not parallel, the point positions will be stored in ptOnThis and ptOnLine2, and we'll return TRUE. slay. ✨

note that both SbLine instances are considered to be infinite in both directions from their definition points, as far as this function is concerned. no endings, no edges, just vibes. 🌈

👀 See also

  • getClosestPoint().

🎀 SbVec3f SbLine::getClosestPoint (const SbVec3f & point) const

returns the point on the line which is closest to point:

                    _
             Q      D
    SP x-----x------->
        \    |
         \   |
          \  |
           \ |
            \|
             x P

 P = argument point            _
 SP = line starting point, and D = line direction of this line
 Q = point to find and return from function

the vector defined by point and the returned point will be normal to the line. perpendicular queen. 💅

note that the SbLine instance is considered to be infinite in both directions from its definition point, as far as this function is concerned.

👀 See also

  • getClosestPoints().

🦋 const SbVec3f & SbLine::getPosition (void ) const

return a vector representing the origin point on the line.

👀 See also

  • setValue

🌸 const SbVec3f & SbLine::getDirection (void ) const

return a vector representing the direction of the line. the direction vector will always be normalized. always. periodt. 💜

💀 void SbLine::print (FILE * fp) const

dump the state of this object to the file stream.

⚠️ only works in the debug version of the library — this method does nothing in an optimized compile. so if you're getting silence, that's why bestie, it's not you 😭

👑 Author 👑

generated automatically by Doxygen for Coin from the source code. she didn't write herself, she was born this way. 🧚

and that's the whole page!! ty for coming to my ted talk 🫶 this was SbLine from Coin, Version 3.1.3, dated SbLine(3) — mwah, go build something cute with it 💖✨

📦 where this page comes from