VTK  9.5.2
vtkVector3< T > Class Template Reference

#include <vtkVector.h>

Inheritance diagram for vtkVector3< T >:
[legend]
Collaboration diagram for vtkVector3< T >:
[legend]

Public Member Functions

 vtkVector3 ()=default
 vtkVector3 (const T &scalar)
 vtkVector3 (const T *init)
 vtkVector3 (const T &x, const T &y, const T &z)
void SetX (const T &x)
 Set the x component of the vector, i.e.
const T & GetX () const
 Get the x component of the vector, i.e.
void SetY (const T &y)
 Set the y component of the vector, i.e.
const T & GetY () const
 Get the y component of the vector, i.e.
void SetZ (const T &z)
 Set the z component of the vector, i.e.
const T & GetZ () const
 Get the z component of the vector, i.e.
void Set (const T &x, const T &y, const T &z)
 Set the x, y and z components of the vector.
vtkVector3< T > Cross (const vtkVector3< T > &other) const
 Return the cross product of this X other.
bool operator< (const vtkVector3< T > &v) const
 Lexicographical comparison of two vector.
Public Member Functions inherited from vtkVector< T, 3 >
 vtkVector ()=default
double Norm () const
 Get the norm of the vector, i.e.
T SquaredNorm () const
 Get the squared norm of the vector.
double Normalize ()
 Normalize the vector in place.
vtkVector< T, Size > Normalized () const
 Return the normalized form of this vector.
T Dot (const vtkVector< T, Size > &other) const
 The dot product of this and the supplied vector.
vtkVector< TR, Size > Cast () const
 Cast the vector to the specified type, returning the result.
Public Member Functions inherited from vtkTuple< T, Size >
 vtkTuple ()=default
 The default constructor does not initialize values.
 vtkTuple (const T &scalar)
 Initialize all of the tuple's elements with the supplied scalar.
 vtkTuple (const T *init)
 Initialize the tuple's elements with the elements of the supplied array.
 vtkTuple (const std::array< T, Size > &values)
 Initialize the tuple's elements using a std::array for matching type and size.
int GetSize () const
 Get the size of the tuple.
T * GetData ()
 Get a pointer to the underlying data of the tuple.
const T * GetData () const
T & operator[] (int i)
 Get a reference to the underlying data element of the tuple.
const T & operator[] (int i) const
T operator() (int i) const
 Get the value of the tuple at the index specified.
bool Compare (const vtkTuple< T, Size > &other, const T &tol) const
 Equality operator with a tolerance to allow fuzzy comparisons.
template<typename TR>
vtkTuple< TR, Size > Cast () const
 Cast the tuple to the specified type, returning the result.

Additional Inherited Members

Protected Attributes inherited from vtkTuple< T, Size >
T Data [Size]
 The only thing stored in memory!

Detailed Description

template<typename T>
class vtkVector3< T >

Definition at line 207 of file vtkVector.h.

Constructor & Destructor Documentation

◆ vtkVector3() [1/4]

template<typename T>
vtkVector3< T >::vtkVector3 ( )
default

◆ vtkVector3() [2/4]

template<typename T>
vtkVector3< T >::vtkVector3 ( const T & scalar)
inlineexplicit

Definition at line 212 of file vtkVector.h.

◆ vtkVector3() [3/4]

template<typename T>
vtkVector3< T >::vtkVector3 ( const T * init)
inlineexplicit

Definition at line 217 of file vtkVector.h.

◆ vtkVector3() [4/4]

template<typename T>
vtkVector3< T >::vtkVector3 ( const T & x,
const T & y,
const T & z )
inline

Definition at line 222 of file vtkVector.h.

Member Function Documentation

◆ Set()

template<typename T>
void vtkVector3< T >::Set ( const T & x,
const T & y,
const T & z )
inline

Set the x, y and z components of the vector.

Definition at line 233 of file vtkVector.h.

◆ SetX()

template<typename T>
void vtkVector3< T >::SetX ( const T & x)
inline

Set the x component of the vector, i.e.

element 0.

Definition at line 244 of file vtkVector.h.

◆ GetX()

template<typename T>
const T & vtkVector3< T >::GetX ( ) const
inline

Get the x component of the vector, i.e.

element 0.

Definition at line 249 of file vtkVector.h.

◆ SetY()

template<typename T>
void vtkVector3< T >::SetY ( const T & y)
inline

Set the y component of the vector, i.e.

element 1.

Definition at line 254 of file vtkVector.h.

◆ GetY()

template<typename T>
const T & vtkVector3< T >::GetY ( ) const
inline

Get the y component of the vector, i.e.

element 1.

Definition at line 259 of file vtkVector.h.

◆ SetZ()

template<typename T>
void vtkVector3< T >::SetZ ( const T & z)
inline

Set the z component of the vector, i.e.

element 2.

Definition at line 264 of file vtkVector.h.

◆ GetZ()

template<typename T>
const T & vtkVector3< T >::GetZ ( ) const
inline

Get the z component of the vector, i.e.

element 2.

Definition at line 269 of file vtkVector.h.

◆ Cross()

template<typename T>
vtkVector3< T > vtkVector3< T >::Cross ( const vtkVector3< T > & other) const
inline

Return the cross product of this X other.

Definition at line 275 of file vtkVector.h.

◆ operator<()

template<typename T>
bool vtkVector3< T >::operator< ( const vtkVector3< T > & v) const
inline

Lexicographical comparison of two vector.

Definition at line 289 of file vtkVector.h.


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