API Documentation
Loading...
Searching...
No Matches
SelectionArea< t_dims, t_type > Class Template Reference

An area of N-dimensional space that is considered selected. More...

#include <SelectionArea.hpp>

Public Member Functions

template<uint01 t_new_dims, class t_new_type >
SelectionArea< t_new_dims, t_new_type > as () const
 
Bounds< t_dims, t_type > & bounds ()
 
const Bounds< t_dims, t_type > & bounds () const
 
const Matrix< t_type > & inversePerspectiveTransform () const
 
const Matrix< t_type > & inverseTransform () const
 
bool isEnabled () const
 
bool isInverse () const
 
bool isPreTransformed () const
 
LineSegment< t_dims, t_type > & line ()
 
const LineSegment< t_dims, t_type > & line () const
 
SelectionMode mode () const
 
bool operator!= (const SelectionArea &area) const
 
SelectionAreaoperator= (const SelectionArea &area)
 
bool operator== (const SelectionArea &area) const
 
Plane< t_dims, t_type > & plane ()
 
const Plane< t_dims, t_type > & plane () const
 
Vertex< t_dims, t_type > & point ()
 
const Vertex< t_dims, t_type > & point () const
 
Polygon< t_type > & polygon ()
 
const Polygon< t_type > & polygon () const
 
void preTransform (const Matrix< t_type > &mat)
 
template<uint01 t_new_dims, class t_new_type >
SelectionArea< t_new_dims, t_new_type > preTransformed () const
 
const Matrix< t_type > & projectionTransform () const
 
 SelectionArea ()
 
 SelectionArea (const Bounds< t_dims, t_type > &bounds)
 
 SelectionArea (const LineSegment< t_dims, t_type > &segment)
 
 SelectionArea (const Plane< t_dims, t_type > &plane)
 
 SelectionArea (const Polygon< t_type > &poly)
 
 SelectionArea (const SelectionArea &area)
 
 SelectionArea (const Vertex< t_dims, t_type > &point)
 
 SelectionArea (Polygon< t_type > &&poly)
 
Bounds< t_dims, t_type > selectionBounds () const
 
void setIsEnabled (bool is_enabled)
 
void setIsInverse (bool is_inverse)
 
void setProjectionMatrix (const Matrix< t_type > &matrix)
 
void setSelection (const Bounds< t_dims, t_type > &bounds)
 
void setSelection (const LineSegment< t_dims, t_type > &segment)
 
void setSelection (const Plane< t_dims, t_type > &plane)
 
void setSelection (const Polygon< t_type > &poly)
 
void setSelection (const Vertex< t_dims, t_type > &point)
 
void setSelection (Polygon< t_type > &&poly)
 
void setTransform (const Matrix< t_type > &matrix)
 
const Matrix< t_type > & transform () const
 
 ~SelectionArea ()
 

Protected Member Functions

void cleanup ()
 

Protected Attributes

union { 
 
   Bounds< t_dims, t_type >   m_bounds 
 
   LineSegment< t_dims, t_type >   m_line 
 
   Plane< t_dims, t_type >   m_plane 
 
   Vertex< t_dims, t_type >   m_point 
 
   Polygon< t_type >   m_polygon 
 
};  
 
Matrix< t_type > m_inverse_matrix = Matrix<t_type>(1)
 
bool m_is_enabled
 
bool m_is_inverse
 
bool m_is_pre_transformed
 
Matrix< t_type > m_matrix = Matrix<t_type>(1)
 
SelectionMode m_mode
 
Matrix< t_type > m_projection_inverse_matrix = Matrix<t_type>(1)
 
Matrix< t_type > m_projection_matrix = Matrix<t_type>(1)
 

Detailed Description

template<uint01 t_dims, class t_type>
class NDEVR::SelectionArea< t_dims, t_type >

An area of N-dimensional space that is considered selected.


Constructor & Destructor Documentation

◆ SelectionArea() [1/8]

template<uint01 t_dims, class t_type >
SelectionArea ( )
inline

◆ SelectionArea() [2/8]

template<uint01 t_dims, class t_type >
SelectionArea ( const SelectionArea< t_dims, t_type > & area)
inline

◆ SelectionArea() [3/8]

template<uint01 t_dims, class t_type >
SelectionArea ( const Vertex< t_dims, t_type > & point)
inline

◆ SelectionArea() [4/8]

template<uint01 t_dims, class t_type >
SelectionArea ( const LineSegment< t_dims, t_type > & segment)
inline

◆ SelectionArea() [5/8]

template<uint01 t_dims, class t_type >
SelectionArea ( const Polygon< t_type > & poly)
inline

◆ SelectionArea() [6/8]

template<uint01 t_dims, class t_type >
SelectionArea ( Polygon< t_type > && poly)
inline

◆ SelectionArea() [7/8]

template<uint01 t_dims, class t_type >
SelectionArea ( const Bounds< t_dims, t_type > & bounds)
inline

◆ SelectionArea() [8/8]

template<uint01 t_dims, class t_type >
SelectionArea ( const Plane< t_dims, t_type > & plane)
inline

◆ ~SelectionArea()

template<uint01 t_dims, class t_type >
~SelectionArea ( )
inline

Member Function Documentation

◆ as()

template<uint01 t_dims, class t_type >
template<uint01 t_new_dims, class t_new_type >
SelectionArea< t_new_dims, t_new_type > as ( ) const
inline

◆ bounds() [1/2]

template<uint01 t_dims, class t_type >
Bounds< t_dims, t_type > & bounds ( )
inline

◆ bounds() [2/2]

template<uint01 t_dims, class t_type >
const Bounds< t_dims, t_type > & bounds ( ) const
inline

◆ cleanup()

template<uint01 t_dims, class t_type >
void cleanup ( )
inlineprotected

◆ inversePerspectiveTransform()

template<uint01 t_dims, class t_type >
const Matrix< t_type > & inversePerspectiveTransform ( ) const
inline

◆ inverseTransform()

template<uint01 t_dims, class t_type >
const Matrix< t_type > & inverseTransform ( ) const
inline

◆ isEnabled()

template<uint01 t_dims, class t_type >
bool isEnabled ( ) const
inline

◆ isInverse()

template<uint01 t_dims, class t_type >
bool isInverse ( ) const
inline

◆ isPreTransformed()

template<uint01 t_dims, class t_type >
bool isPreTransformed ( ) const
inline

◆ line() [1/2]

template<uint01 t_dims, class t_type >
LineSegment< t_dims, t_type > & line ( )
inline

◆ line() [2/2]

template<uint01 t_dims, class t_type >
const LineSegment< t_dims, t_type > & line ( ) const
inline

◆ mode()

template<uint01 t_dims, class t_type >
SelectionMode mode ( ) const
inline

◆ operator!=()

template<uint01 t_dims, class t_type >
bool operator!= ( const SelectionArea< t_dims, t_type > & area) const
inline

◆ operator=()

template<uint01 t_dims, class t_type >
SelectionArea & operator= ( const SelectionArea< t_dims, t_type > & area)
inline

◆ operator==()

template<uint01 t_dims, class t_type >
bool operator== ( const SelectionArea< t_dims, t_type > & area) const
inline

◆ plane() [1/2]

template<uint01 t_dims, class t_type >
Plane< t_dims, t_type > & plane ( )
inline

◆ plane() [2/2]

template<uint01 t_dims, class t_type >
const Plane< t_dims, t_type > & plane ( ) const
inline

◆ point() [1/2]

template<uint01 t_dims, class t_type >
Vertex< t_dims, t_type > & point ( )
inline

◆ point() [2/2]

template<uint01 t_dims, class t_type >
const Vertex< t_dims, t_type > & point ( ) const
inline

◆ polygon() [1/2]

template<uint01 t_dims, class t_type >
Polygon< t_type > & polygon ( )
inline

◆ polygon() [2/2]

template<uint01 t_dims, class t_type >
const Polygon< t_type > & polygon ( ) const
inline

◆ preTransform()

template<uint01 t_dims, class t_type >
void preTransform ( const Matrix< t_type > & mat)
inline

◆ preTransformed()

template<uint01 t_dims, class t_type >
template<uint01 t_new_dims, class t_new_type >
SelectionArea< t_new_dims, t_new_type > preTransformed ( ) const
inline

◆ projectionTransform()

template<uint01 t_dims, class t_type >
const Matrix< t_type > & projectionTransform ( ) const
inline

◆ selectionBounds()

template<uint01 t_dims, class t_type >
Bounds< t_dims, t_type > selectionBounds ( ) const
inline

◆ setIsEnabled()

template<uint01 t_dims, class t_type >
void setIsEnabled ( bool is_enabled)
inline

◆ setIsInverse()

template<uint01 t_dims, class t_type >
void setIsInverse ( bool is_inverse)
inline

◆ setProjectionMatrix()

template<uint01 t_dims, class t_type >
void setProjectionMatrix ( const Matrix< t_type > & matrix)
inline

◆ setSelection() [1/6]

template<uint01 t_dims, class t_type >
void setSelection ( const Bounds< t_dims, t_type > & bounds)
inline

◆ setSelection() [2/6]

template<uint01 t_dims, class t_type >
void setSelection ( const LineSegment< t_dims, t_type > & segment)
inline

◆ setSelection() [3/6]

template<uint01 t_dims, class t_type >
void setSelection ( const Plane< t_dims, t_type > & plane)
inline

◆ setSelection() [4/6]

template<uint01 t_dims, class t_type >
void setSelection ( const Polygon< t_type > & poly)
inline

◆ setSelection() [5/6]

template<uint01 t_dims, class t_type >
void setSelection ( const Vertex< t_dims, t_type > & point)
inline

◆ setSelection() [6/6]

template<uint01 t_dims, class t_type >
void setSelection ( Polygon< t_type > && poly)
inline

◆ setTransform()

template<uint01 t_dims, class t_type >
void setTransform ( const Matrix< t_type > & matrix)
inline

◆ transform()

template<uint01 t_dims, class t_type >
const Matrix< t_type > & transform ( ) const
inline

Member Data Documentation

◆ [union]

union { ... }

◆ m_bounds

template<uint01 t_dims, class t_type >
Bounds<t_dims, t_type> m_bounds

◆ m_inverse_matrix

template<uint01 t_dims, class t_type >
Matrix<t_type> m_inverse_matrix = Matrix<t_type>(1)
protected

◆ m_is_enabled

template<uint01 t_dims, class t_type >
bool m_is_enabled
protected

◆ m_is_inverse

template<uint01 t_dims, class t_type >
bool m_is_inverse
protected

◆ m_is_pre_transformed

template<uint01 t_dims, class t_type >
bool m_is_pre_transformed
protected

◆ m_line

template<uint01 t_dims, class t_type >
LineSegment<t_dims, t_type> m_line

◆ m_matrix

template<uint01 t_dims, class t_type >
Matrix<t_type> m_matrix = Matrix<t_type>(1)
protected

◆ m_mode

template<uint01 t_dims, class t_type >
SelectionMode m_mode
protected

◆ m_plane

template<uint01 t_dims, class t_type >
Plane<t_dims, t_type> m_plane

◆ m_point

template<uint01 t_dims, class t_type >
Vertex<t_dims, t_type> m_point

◆ m_polygon

template<uint01 t_dims, class t_type >
Polygon<t_type> m_polygon

◆ m_projection_inverse_matrix

template<uint01 t_dims, class t_type >
Matrix<t_type> m_projection_inverse_matrix = Matrix<t_type>(1)
protected

◆ m_projection_matrix

template<uint01 t_dims, class t_type >
Matrix<t_type> m_projection_matrix = Matrix<t_type>(1)
protected

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