VISR  0.12.0
Versatile Interactive Scene Renderer
visr::rbbl::InterpolationParameter Class Reference

#include <interpolation_parameter.hpp>

Inheritance diagram for visr::rbbl::InterpolationParameter:
visr::pml::InterpolationParameter

Public Types

using IdType = std::size_t
 
using IndexType = std::size_t
 
using WeightType = float
 
using IndexContainer = std::vector< IndexType >
 
using WeightContainer = std::vector< WeightType >
 

Public Member Functions

 InterpolationParameter (InterpolationParameter const &rhs)
 
 InterpolationParameter (IdType id, std::size_t numberOfInterpolants)
 
 InterpolationParameter (IdType id, IndexContainer const &indices, WeightContainer const &weights)
 
 InterpolationParameter (IdType id, std::initializer_list< IndexType > const &indices, std::initializer_list< WeightType > const &weights)
 
 ~InterpolationParameter ()
 
IdType id () const
 
void setId (IdType newId)
 
std::size_t numberOfInterpolants () const
 
IndexType index (std::size_t idx) const
 
IndexContainer const & indices () const
 
WeightContainer const & weights () const
 
WeightType weight (std::size_t idx) const
 
void setIndex (std::size_t idx, IndexType newIndex)
 
void setIndices (IndexContainer const &newIndices)
 
void setIndices (std::initializer_list< IndexType > const &newWeights)
 
void setWeight (std::size_t idx, WeightType weight)
 
void setWeights (WeightContainer const &newWeights)
 
void setWeights (std::initializer_list< WeightType > const &newWeights)
 

Static Public Attributes

static IdType constexpr cInvalidId = std::numeric_limits<IdType>::max()
 
static IndexType constexpr cInvalidIndex = std::numeric_limits<IndexType>::max()
 

Detailed Description

A data structure for interpolation .

Member Typedef Documentation

◆ IdType

◆ IndexContainer

◆ IndexType

◆ WeightContainer

◆ WeightType

Constructor & Destructor Documentation

◆ InterpolationParameter() [1/4]

visr::rbbl::InterpolationParameter::InterpolationParameter ( InterpolationParameter const &  rhs)
default

◆ InterpolationParameter() [2/4]

visr::rbbl::InterpolationParameter::InterpolationParameter ( IdType  id,
std::size_t  numberOfInterpolants 
)
explicit

◆ InterpolationParameter() [3/4]

visr::rbbl::InterpolationParameter::InterpolationParameter ( IdType  id,
IndexContainer const &  indices,
WeightContainer const &  weights 
)
explicit

◆ InterpolationParameter() [4/4]

visr::rbbl::InterpolationParameter::InterpolationParameter ( IdType  id,
std::initializer_list< IndexType > const &  indices,
std::initializer_list< WeightType > const &  weights 
)
explicit

◆ ~InterpolationParameter()

visr::rbbl::InterpolationParameter::~InterpolationParameter ( )
default

Member Function Documentation

◆ id()

InterpolationParameter::IdType visr::rbbl::InterpolationParameter::id ( ) const

◆ index()

InterpolationParameter::IndexType visr::rbbl::InterpolationParameter::index ( std::size_t  idx) const

◆ indices()

InterpolationParameter::IndexContainer const & visr::rbbl::InterpolationParameter::indices ( ) const

◆ numberOfInterpolants()

std::size_t visr::rbbl::InterpolationParameter::numberOfInterpolants ( ) const

◆ setId()

void visr::rbbl::InterpolationParameter::setId ( IdType  newId)

◆ setIndex()

void visr::rbbl::InterpolationParameter::setIndex ( std::size_t  idx,
IndexType  newIndex 
)

◆ setIndices() [1/2]

void visr::rbbl::InterpolationParameter::setIndices ( IndexContainer const &  newIndices)

◆ setIndices() [2/2]

void visr::rbbl::InterpolationParameter::setIndices ( std::initializer_list< IndexType > const &  newWeights)

◆ setWeight()

void visr::rbbl::InterpolationParameter::setWeight ( std::size_t  idx,
WeightType  weight 
)

◆ setWeights() [1/2]

void visr::rbbl::InterpolationParameter::setWeights ( WeightContainer const &  newWeights)

◆ setWeights() [2/2]

void visr::rbbl::InterpolationParameter::setWeights ( std::initializer_list< WeightType > const &  newWeights)

◆ weight()

InterpolationParameter::WeightType visr::rbbl::InterpolationParameter::weight ( std::size_t  idx) const

◆ weights()

InterpolationParameter::WeightContainer const & visr::rbbl::InterpolationParameter::weights ( ) const

Member Data Documentation

◆ cInvalidId

InterpolationParameter::IdType constexpr visr::rbbl::InterpolationParameter::cInvalidId = std::numeric_limits<IdType>::max()
static

Provide definitions for static constepr members.

◆ cInvalidIndex

InterpolationParameter::IndexType constexpr visr::rbbl::InterpolationParameter::cInvalidIndex = std::numeric_limits<IndexType>::max()
static

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