SbVec4ub(3)

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

🌸 SbVec4ub(3) β€” like, the NAME section 🌸

Okay bestie, welcome to the Library Functions Manual πŸ’– this is the page for SbVec4ub, and she is a 4 dimensional vector with unsigned 8-bit integer coordinates. That's it, that's the girl. πŸ‘‘


✨ SYNOPSIS ✨

First things first, you gotta pull her in:

#include <Inventor/SbVec4ub.h>

🫢 Public Member Functions

  • SbVec4ub (void)
  • SbVec4ub (const uint8_t v[4])
  • SbVec4ub (uint8_t x, uint8_t y, uint8_t z, uint8_t w)
  • SbVec4ub (const SbVec4b &v)
  • SbVec4ub (const SbVec4us &v)
  • SbVec4ub (const SbVec4ui32 &v)
  • SbVec4ub & setValue (const uint8_t v[4])
  • SbVec4ub & setValue (uint8_t x, uint8_t y, uint8_t z, uint8_t w)
  • SbVec4ub & setValue (const SbVec4b &v)
  • SbVec4ub & setValue (const SbVec4us &v)
  • SbVec4ub & setValue (const SbVec4ui32 &v)
  • const uint8_t * getValue (void) const
  • void getValue (uint8_t &x, uint8_t &y, uint8_t &z, uint8_t &w) const
  • uint8_t & operator[] (int i)
  • const uint8_t & operator[] (int i) const
  • int32_t dot (SbVec4ub v) const
  • void negate (void)
  • SbVec4ub & operator*= (int d)
  • SbVec4ub & operator*= (double d)
  • SbVec4ub & operator/= (int d)
  • SbVec4ub & operator/= (double d)
  • SbVec4ub & operator+= (SbVec4ub v)
  • SbVec4ub & operator-= (SbVec4ub v)
  • SbVec4ub operator- (void) const

πŸ”’ Protected Attributes

  • uint8_t vec [4]

πŸ’œ Detailed Description πŸ’œ

The SbVec4ub class is a 4 dimensional vector with unsigned 8-bit integer coordinates. No cap. 🧚

This vector class provides storage for a 3 dimensional homogeneous vector β€” the 4 components are usually referred to as <x, y, z, w> β€” aswell as simple integer precision arithmetic operations. It's giving math but make it cute. ✨

See also: SbVec2ub, SbVec3ub, SbVec4b, SbVec4s, SbVec4us, SbVec4i32, SbVec4ui32 β€” the whole friend group, fr fr. 🫢

Since: Coin-2.5 β€” she's been iconic since 2.5, iykyk. πŸ‘‘


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

SbVec4ub::SbVec4ub (void ) [inline]

The default constructor does nothing. Like, genuinely nothing. The vector coordinates will be uninitialized until a call the setValue(). So don't go reading them before you set them, bestie, that's not the vibe. 😭

Referenced by dot(), operator*=(), operator+=(), operator-(), operator-=(), operator/=(), operator/=(), setValue(), and setValue().

SbVec4ub::SbVec4ub (const uint8_t v[4]) [inline]

Constructs an SbVec4ub instance with initial values from v. Simple, clean, slay. πŸ’…

SbVec4ub::SbVec4ub (uint8_t x, uint8_t y, uint8_t z, uint8_t w) [inline]

Constructs an SbVec4ub instance with the initial homogeneous vector set to <x,y,z,w>. Four numbers, one dream. 🌈

SbVec4ub::SbVec4ub (const SbVec4b & v) [inline], [explicit]

Constructs an SbVec4ub instance with initial values from the 8-bit integer precision vector v. It's explicit so no sneaky conversions, she's got boundaries. βœ‹

References setValue().

SbVec4ub::SbVec4ub (const SbVec4us & v) [inline], [explicit]

Constructs an SbVec4ub instance with initial values from the unsigned short integer precision vector v.

References setValue().

SbVec4ub::SbVec4ub (const SbVec4ui32 & v) [inline], [explicit]

Constructs an SbVec4ub instance with initial values from the unsigned 32-bit integer precision vector v.

References setValue().


πŸ”₯ Member Function Documentation πŸ”₯

SbVec4ub & SbVec4ub::setValue (const uint8_t v[4]) [inline]

Set new coordinates for the vector from v. Returns reference to self β€” because she always comes back to you. πŸ’–

See also: getValue()

References SbVec4ub().

Referenced by SbVec4ub(), SbVec4ub(), and SbVec4ub(). (Yes, all three of them. We don't ask questions. πŸ’€)

SbVec4ub & SbVec4ub::setValue (uint8_t x, uint8_t y, uint8_t z, uint8_t w) [inline]

Set new coordinates for the vector. Returns reference to self.

See also: getValue()

References SbVec4ub().

SbVec4ub & SbVec4ub::setValue (const SbVec4b & v)

Sets this vector to the 8-bit integer precision vector v, converting the vector to a unsigned 8-bit integer precision vector.

SbVec4ub & SbVec4ub::setValue (const SbVec4us & v)

Sets this vector to the unsigned short integer precision vector v, converting the vector to a unsigned 8-bit integer precision vector.

SbVec4ub & SbVec4ub::setValue (const SbVec4ui32 & v)

Sets this vector to the unsigned 32-bit integer precision vector v, converting the vector to a unsigned 8-bit integer precision vector.

const uint8_t * SbVec4ub::getValue (void ) const [inline]

Returns a pointer to an array of four uint8_t integers containing the x, y, z and w coordinates of the vector. Pointy. 🫡

See also: setValue()

void SbVec4ub::getValue (uint8_t & x, uint8_t & y, uint8_t & z, uint8_t & w) const [inline]

Returns the x, y, z and w coordinates of the vector. Handing them straight to your refs. πŸ’…

uint8_t & SbVec4ub::operator[] (int i) [inline]

Index operator. Returns modifiable x, y, z or w coordinate of the vector. Go ahead, edit her, she can take it. ✨

const uint8_t & SbVec4ub::operator[] (int i) const [inline]

Index operator. Returns non-modifiable x, y, z or w coordinate of the vector. Look, don't touch. πŸ™ˆ

int32_t SbVec4ub::dot (SbVec4ub v) const [inline]

Calculates and returns the result of taking the dot product of this vector and v. Math girlies rise. πŸ”₯

References SbVec4ub().

void SbVec4ub::negate (void )

Negate the vector (i.e. point it in the opposite direction). Main character flip. πŸ”„

Referenced by operator-().

SbVec4ub & SbVec4ub::operator*= (int d) [inline]

Multiply components of vector with scalar value d. Returns reference to self.

References SbVec4ub().

SbVec4ub & SbVec4ub::operator*= (double d)

Multiply components of vector with value d. Returns reference to self.

SbVec4ub & SbVec4ub::operator/= (int d) [inline]

Divides components of vector with scalar value d. Returns reference to self.

References SbVec4ub().

SbVec4ub & SbVec4ub::operator/= (double d) [inline]

Divides components of vector with scalar value d. Returns reference to self.

References SbVec4ub().

SbVec4ub & SbVec4ub::operator+= (SbVec4ub v) [inline]

Adds this vector and vector u. Returns reference to self. (The text says u even though the parameter is v β€” not me snitching, just reporting. πŸ’€)

References SbVec4ub().

SbVec4ub & SbVec4ub::operator-= (SbVec4ub v) [inline]

Subtracts v from this vector. Returns reference to self.

References SbVec4ub().

SbVec4ub SbVec4ub::operator- (void ) const [inline]

Non-destructive negation operator. Returns a new SbVec4ub instance which points in the opposite direction of this vector. She doesn't change herself for you, she just makes a new one. πŸ’…

See also: negate()

References negate(), and SbVec4ub().


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code. So like, a robot wrote this, but I'm the one giving it the personality. πŸ’–


And that's the whole page, bestie!! πŸŽ€ No notes, ate and left no crumbs. This gorgeous thing comes from Coin Version 2.5.0 and it lives happily in section SbVec4ub(3). Go forth and vector responsibly, mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from