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

Additional Inherited Members

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

Detailed Description

template<typename T>
class vtkVector2< T >

Definition at line 171 of file vtkVector.h.

Constructor & Destructor Documentation

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

Definition at line 176 of file vtkVector.h.

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

Definition at line 181 of file vtkVector.h.

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

Definition at line 186 of file vtkVector.h.

Member Function Documentation

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 196 of file vtkVector.h.

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 206 of file vtkVector.h.

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

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

element 0.

Definition at line 211 of file vtkVector.h.

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 216 of file vtkVector.h.

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

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

element 1.

Definition at line 221 of file vtkVector.h.

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

Lexicographical comparison of two vector.

Definition at line 227 of file vtkVector.h.


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