Specialization of Vec for 4D vectors (used for representing 4D points or vectors in homogeneous coordinates, or RGBA colors). More...

#include <easy3d/core/vec.h>

Public Types
typedef Vec< 4, T >	thisclass
	The type of this class.

Public Member Functions
	Vec ()
	Default constructor. Initializes x, y, z, and w to zero.

	Vec (const Vec< 3, T > &v, const T &s=1)
	Constructs a 4D vector from a 3D vector and a scalar (useful for promoting to homogeneous coordinates).

	Vec (T x_in, T y_in, T z_in, T w_in)
	Constructs a 4D vector with the given x, y, z, and w values.

	Vec (const T &s)
	Constructs a 4D vector with all elements initialized to a scalar value.

template<class T2 >
	Vec (const Vec< 4, T2 > &v)
	Constructs a 4D vector from another 4D vector of a different scalar type.

template<class T2 >
	Vec (const T2 *v)
	Constructs a 4D vector from an array of values.

T	length2 () const
	Returns the squared length of this vector.

T	length () const
	Returns the length of this vector.

T	norm () const
	Returns the norm (i.e., length/magnitude) of this vector.

T	distance2 (const thisclass &rhs) const
	Returns the squared Euclidean distance to another vector.

thisclass &	normalize ()
	Normalizes this vector.

thisclass &	operator+= (const thisclass &v)
	Compound addition with another vector.

thisclass &	operator-= (const thisclass &v)
	Compound subtraction with another vector.

thisclass &	operator*= (const thisclass &v)
	Compound component-wise multiplication with another vector.

thisclass &	operator/= (const thisclass &v)
	Compound component-wise division with another vector.

template<class T2 >
thisclass &	operator*= (T2 s)
	Compound vector-scalar multiplication.

template<class T2 >
thisclass &	operator/= (T2 s)
	Compound vector-scalar division.

thisclass	operator+ (const thisclass &v) const
	Addition with another vector.

thisclass	operator- (const thisclass &v) const
	Subtraction with another vector.

template<class T2 >
thisclass	operator* (T2 s) const
	Vector-scalar multiplication.

template<class T2 >
thisclass	operator/ (T2 s) const
	Vector-scalar division.

thisclass	operator- () const
	Negates this vector (i.e., adds a minus sign).

T *	data ()
	Returns the memory address of the vector.

const T *	data () const
	Returns the constant memory address of the vector.

Vec< 3, T >	xyz () const
	Returns the (x, y, z) components of this vector as a 3D vector.

	operator const T * () const
	Conversion operator returning the constant memory address of the data. Very convenient to pass this vector as a data pointer to functions.

	operator T* ()
	Conversion operator returning the memory address of the data. Very convenient to pass thisvector as a data pointer to functions.

Static Public Member Functions
static size_t	dimension ()
	Returns the dimension/size of this vector.

static size_t	size ()
	Returns the dimension/size of this vector.

Public Attributes
union easy3d::Vec< 4, T >:: { ... }
	Data intentionally left public to allow direct access (e.g., vec.x).

Detailed Description

template<class T>
class easy3d::Vec< 4, T >

Specialization of Vec for 4D vectors (used for representing 4D points or vectors in homogeneous coordinates, or RGBA colors).

Template Parameters

T	The scalar type of vector elements.

Member Typedef Documentation

◆ thisclass

template<class T >

typedef Vec<4, T> thisclass

The type of this class.

This typedef represents the type of the current class.

Constructor & Destructor Documentation

◆ Vec() [1/5]

template<class T >

Vec	(	const Vec< 3, T > &	v,
		const T &	s = `1`
	)

inlineexplicit

Constructs a 4D vector from a 3D vector and a scalar (useful for promoting to homogeneous coordinates).

Parameters

v	The 3D vector.
s	The scalar value for the w-coordinate (default is 1).

◆ Vec() [2/5]

template<class T >

Vec	(	T	x_in,
		T	y_in,
		T	z_in,
		T	w_in
	)

inline

Constructs a 4D vector with the given x, y, z, and w values.

Parameters

x_in	The x-coordinate.
y_in	The y-coordinate.
z_in	The z-coordinate.
w_in	The w-coordinate.

◆ Vec() [3/5]

template<class T >

Vec ( const T & s )

inlineexplicit

Constructs a 4D vector with all elements initialized to a scalar value.

Parameters

s	The scalar value to initialize all elements of the vector.

◆ Vec() [4/5]

template<class T >

template<class T2 >

Vec ( const Vec< 4, T2 > & v )

inlineexplicit

Constructs a 4D vector from another 4D vector of a different scalar type.

Template Parameters

T2	The scalar type of the source vector.

Parameters

v	The source vector.

◆ Vec() [5/5]

template<class T >

template<class T2 >

Vec ( const T2 * v )

inlineexplicit

Constructs a 4D vector from an array of values.

Template Parameters

T2	The scalar type of the source array.

Parameters

v	The source array.

Member Function Documentation

◆ data() [1/2]

template<class T >

T * data ( )

inline

Returns the memory address of the vector.

Returns: A pointer to the underlying data array.

◆ data() [2/2]

template<class T >

const T * data ( ) const

inline

Returns the constant memory address of the vector.

Returns: A const pointer to the underlying data array.

◆ dimension()

template<class T >

static size_t dimension ( )

inlinestatic

Returns the dimension/size of this vector.

Returns: The dimension of the vector (always 4).

◆ distance2()

template<class T >

T distance2 ( const thisclass & rhs ) const

inline

Returns the squared Euclidean distance to another vector.

Parameters

rhs	The other vector.

Returns: The squared distance between this vector and rhs.

◆ length()

template<class T >

T length ( ) const

inline

Returns the length of this vector.

Returns: The length of the vector.

◆ length2()

template<class T >

T length2 ( ) const

inline

Returns the squared length of this vector.

Returns: The squared length of the vector.

◆ norm()

template<class T >

T norm ( ) const

inline

Returns the norm (i.e., length/magnitude) of this vector.

Returns: The norm of the vector.

◆ normalize()

template<class T >

thisclass & normalize ( )

inline

Normalizes this vector.

Returns: A reference to this vector after normalization.

◆ operator const T *()

template<class T >

operator const T * ( ) const

inline

Conversion operator returning the constant memory address of the data. Very convenient to pass this vector as a data pointer to functions.

Returns: A const pointer to the underlying data array.

◆ operator T*()

template<class T >

operator T* ( )

inline

Conversion operator returning the memory address of the data. Very convenient to pass thisvector as a data pointer to functions.

Returns: A pointer to the underlying data array.

◆ operator*()

template<class T >

template<class T2 >

thisclass operator* ( T2 s ) const

inline

Vector-scalar multiplication.

Template Parameters

T2	The scalar type.

Parameters

s	The scalar to multiply.

Returns: The resulting vector after multiplication.

◆ operator*=() [1/2]

template<class T >

thisclass & operator*= ( const thisclass & v )

inline

Compound component-wise multiplication with another vector.

Parameters

v	The vector to multiply.

Returns: A reference to this vector after multiplication.

◆ operator*=() [2/2]

template<class T >

template<class T2 >

thisclass & operator*= ( T2 s )

inline

Compound vector-scalar multiplication.

Template Parameters

T2	The scalar type.

Parameters

s	The scalar to multiply.

Returns: A reference to this vector after multiplication.

◆ operator+()

template<class T >

thisclass operator+ ( const thisclass & v ) const

inline

Addition with another vector.

Parameters

v	The vector to add.

Returns: The resulting vector after addition.

◆ operator+=()

template<class T >

thisclass & operator+= ( const thisclass & v )

inline

Compound addition with another vector.

Parameters

v	The vector to add.

Returns: A reference to this vector after addition.

◆ operator-() [1/2]

template<class T >

thisclass operator- ( ) const

inline

Negates this vector (i.e., adds a minus sign).

Returns: The negated vector.

◆ operator-() [2/2]

template<class T >

thisclass operator- ( const thisclass & v ) const

inline

Subtraction with another vector.

Parameters

v	The vector to subtract.

Returns: The resulting vector after subtraction.

◆ operator-=()

template<class T >

thisclass & operator-= ( const thisclass & v )

inline

Compound subtraction with another vector.

Parameters

v	The vector to subtract.

Returns: A reference to this vector after subtraction.

◆ operator/()

template<class T >

template<class T2 >

thisclass operator/ ( T2 s ) const

inline

Vector-scalar division.

Template Parameters

T2	The scalar type.

Parameters

s	The scalar to divide.

Returns: The resulting vector after division.

◆ operator/=() [1/2]

template<class T >

thisclass & operator/= ( const thisclass & v )

inline

Compound component-wise division with another vector.

Parameters

v	The vector to divide.

Returns: A reference to this vector after division.

◆ operator/=() [2/2]

template<class T >

template<class T2 >

thisclass & operator/= ( T2 s )

inline

Compound vector-scalar division.

Template Parameters

T2	The scalar type.

Parameters

s	The scalar to divide.

Returns: A reference to this vector after division.

◆ size()

template<class T >

static size_t size ( )

inlinestatic

Returns the dimension/size of this vector.

Returns: The size of the vector (always 4).

◆ xyz()

template<class T >

Vec< 3, T > xyz ( ) const

inline

Returns the (x, y, z) components of this vector as a 3D vector.

Returns: A 3D vector containing the x, y, and z components.

The documentation for this class was generated from the following file:

easy3d/core/vec.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ thisclass

Constructor & Destructor Documentation

◆ Vec() [1/5]

◆ Vec() [2/5]

◆ Vec() [3/5]

◆ Vec() [4/5]

◆ Vec() [5/5]

Member Function Documentation

◆ data() [1/2]

◆ data() [2/2]

◆ dimension()

◆ distance2()

◆ length()

◆ length2()

◆ norm()

◆ normalize()

◆ operator const T *()

◆ operator T*()

◆ operator*()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ size()

◆ xyz()