VTK
Public Member Functions
vtkVector< T, Size > Class Template Reference

templated base type for storage of vectors. More...

#include <vtkVector.h>

Inheritance diagram for vtkVector< T, Size >:
Inheritance graph
[legend]
Collaboration diagram for vtkVector< T, Size >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 vtkVector ()
 vtkVector (const T &scalar)
 vtkVector (const T *init)
SquaredNorm () const
double Norm () const
double Normalize ()
vtkVector< T, Size > Normalized () const
Dot (const vtkVector< T, Size > &other) const
template<typename TR >
vtkVector< TR, Size > Cast () const

Detailed Description

template<typename T, int Size>
class vtkVector< T, Size >

templated base type for storage of vectors.

This class is a templated data type for storing and manipulating fixed size vectors, which can be used to represent two and three dimensional points. The memory layout is a contiguous array of the specified type, such that a float[2] can be cast to a vtkVector2f and manipulated. Also a float[6] could be cast and used as a vtkVector2f[3].

Tests:
vtkVector (Tests)

Definition at line 39 of file vtkVector.h.


Constructor & Destructor Documentation

template<typename T, int Size>
vtkVector< T, Size >::vtkVector ( ) [inline]

Definition at line 42 of file vtkVector.h.

template<typename T, int Size>
vtkVector< T, Size >::vtkVector ( const T &  scalar) [inline, explicit]

Initialize all of the vector's elements with the supplied scalar.

Definition at line 48 of file vtkVector.h.

template<typename T, int Size>
vtkVector< T, Size >::vtkVector ( const T *  init) [inline, explicit]

Initalize the vector's elements with the elements of the supplied array. Note that the supplied pointer must contain at least as many elements as the vector, or it will result in access to out of bounds memory.

Definition at line 58 of file vtkVector.h.


Member Function Documentation

template<typename T, int Size>
T vtkVector< T, Size >::SquaredNorm ( ) const [inline]

Get the squared norm of the vector.

Definition at line 65 of file vtkVector.h.

template<typename T, int Size>
double vtkVector< T, Size >::Norm ( ) const [inline]

Get the norm of the vector, i.e. its length.

Definition at line 78 of file vtkVector.h.

template<typename T, int Size>
double vtkVector< T, Size >::Normalize ( ) [inline]

Normalize the vector in place.

Returns:
The length of the vector.

Definition at line 86 of file vtkVector.h.

template<typename T, int Size>
vtkVector<T, Size> vtkVector< T, Size >::Normalized ( ) const [inline]

Return the normalized form of this vector.

Returns:
The normalized form of this vector.

Definition at line 101 of file vtkVector.h.

template<typename T, int Size>
T vtkVector< T, Size >::Dot ( const vtkVector< T, Size > &  other) const [inline]

The dot product of this and the supplied vector.

Definition at line 111 of file vtkVector.h.

template<typename T, int Size>
template<typename TR >
vtkVector<TR, Size> vtkVector< T, Size >::Cast ( ) const [inline]

Cast the vector to the specified type, returning the result.

Reimplemented from vtkTuple< T, Size >.

Definition at line 125 of file vtkVector.h.


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