VTK  9.6.2
vtkVector2< T > Class Template Reference

#include <vtkVector.h>

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

Public Member Functions

 vtkVector2 ()=default
 vtkVector2 (const T &scalar)
 vtkVector2 (const T *init)
 vtkVector2 (const T &x, const T &y)
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 Set (const T &x, const T &y)
 Set the x and y components of the vector.
bool operator< (const vtkVector2< T > &v) const
 Lexicographical comparison of two vector.
Public Member Functions inherited from vtkVector< T, 2 >
 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 vtkVector2< T >

Definition at line 141 of file vtkVector.h.

Constructor & Destructor Documentation

◆ vtkVector2() [1/4]

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

◆ vtkVector2() [2/4]

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

Definition at line 146 of file vtkVector.h.

◆ vtkVector2() [3/4]

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

Definition at line 151 of file vtkVector.h.

◆ vtkVector2() [4/4]

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

Definition at line 156 of file vtkVector.h.

Member Function Documentation

◆ Set()

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

Set the x and y components of the vector.

Definition at line 166 of file vtkVector.h.

◆ SetX()

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

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

element 0.

Definition at line 176 of file vtkVector.h.

◆ GetX()

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

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

element 0.

Definition at line 181 of file vtkVector.h.

◆ SetY()

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

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

element 1.

Definition at line 186 of file vtkVector.h.

◆ GetY()

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

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

element 1.

Definition at line 191 of file vtkVector.h.

◆ operator<()

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

Lexicographical comparison of two vector.

Definition at line 197 of file vtkVector.h.


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