VTK  9.4.20241121
Public Member Functions | List of all members
vtkColor3< T > Class Template Reference

#include <vtkColor.h>

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

Public Member Functions

 vtkColor3 ()=default
 
 vtkColor3 (const T &scalar)
 
 vtkColor3 (const T *init)
 
 vtkColor3 (const T &red, const T &green, const T &blue)
 
void SetRed (const T &red)
 Set the red component of the color, i.e.
 
const T & GetRed () const
 Get the red component of the color, i.e.
 
void SetGreen (const T &green)
 Set the green component of the color, i.e.
 
const T & GetGreen () const
 Get the green component of the color, i.e.
 
void SetBlue (const T &blue)
 Set the blue component of the color, i.e.
 
const T & GetBlue () const
 Get the blue component of the color, i.e.
 
void Set (const T &red, const T &green, const T &blue)
 Set the red, green and blue components of the color.
 
- Public Member Functions inherited from vtkTuple< T, 3 >
 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
 
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.
 
vtkTuple< TR, Size > Cast () const
 Cast the tuple to the specified type, returning the result.
 

Additional Inherited Members

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

Detailed Description

template<typename T>
class vtkColor3< T >

Definition at line 42 of file vtkColor.h.

Constructor & Destructor Documentation

◆ vtkColor3() [1/4]

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

◆ vtkColor3() [2/4]

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

Definition at line 47 of file vtkColor.h.

◆ vtkColor3() [3/4]

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

Definition at line 52 of file vtkColor.h.

◆ vtkColor3() [4/4]

template<typename T >
vtkColor3< T >::vtkColor3 ( const T &  red,
const T &  green,
const T &  blue 
)
inline

Definition at line 57 of file vtkColor.h.

Member Function Documentation

◆ Set()

template<typename T >
void vtkColor3< T >::Set ( const T &  red,
const T &  green,
const T &  blue 
)
inline

Set the red, green and blue components of the color.

Definition at line 68 of file vtkColor.h.

◆ SetRed()

template<typename T >
void vtkColor3< T >::SetRed ( const T &  red)
inline

Set the red component of the color, i.e.

element 0.

Definition at line 79 of file vtkColor.h.

◆ GetRed()

template<typename T >
const T & vtkColor3< T >::GetRed ( ) const
inline

Get the red component of the color, i.e.

element 0.

Definition at line 84 of file vtkColor.h.

◆ SetGreen()

template<typename T >
void vtkColor3< T >::SetGreen ( const T &  green)
inline

Set the green component of the color, i.e.

element 1.

Definition at line 89 of file vtkColor.h.

◆ GetGreen()

template<typename T >
const T & vtkColor3< T >::GetGreen ( ) const
inline

Get the green component of the color, i.e.

element 1.

Definition at line 94 of file vtkColor.h.

◆ SetBlue()

template<typename T >
void vtkColor3< T >::SetBlue ( const T &  blue)
inline

Set the blue component of the color, i.e.

element 2.

Definition at line 99 of file vtkColor.h.

◆ GetBlue()

template<typename T >
const T & vtkColor3< T >::GetBlue ( ) const
inline

Get the blue component of the color, i.e.

element 2.

Definition at line 104 of file vtkColor.h.


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