ImFusion C++ SDK 4.4.0
ImFusion::VectorParameterWrapper< T > Class Template Reference

#include <ImFusion/Base/ParameterOptimization.h>

Wrap a vector into a ParameterWrapperBase instance. More...

Inheritance diagram for ImFusion::VectorParameterWrapper< T >:

Detailed Description

template<typename T>
class ImFusion::VectorParameterWrapper< T >

Wrap a vector into a ParameterWrapperBase instance.

This class is templated to allow for vec2, vec3, vec4, std::vector<*> of such, and the corresponding Parameter<*> types.

Warning
: For Parameter<*> types, each deserialize may trigger a signalChanged

Public Member Functions

 VectorParameterWrapper (T &value, std::optional< std::string > name=std::nullopt)
 VectorParameterWrapper (const VectorParameterWrapper &)=default
int dim () const override
 The number of (scalar) parameters wrapped by this object.
void deserialize (const double *v) override
 Update the stored references from a double representation.
void serialize (double *v) const override
 Updates a double representation from the stored references.
std::string name (int i) const override
 Name of the ith parameter, used for display purposes.
std::unique_ptr< ParameterWrapperBase > clone () const override
 Clone function.

Member Function Documentation

◆ dim()

template<typename T>
int ImFusion::VectorParameterWrapper< T >::dim ( ) const
overridevirtual

The number of (scalar) parameters wrapped by this object.

Implements ImFusion::ParameterWrapperBase.

◆ deserialize()

template<typename T>
void ImFusion::VectorParameterWrapper< T >::deserialize ( const double * v)
overridevirtual

Update the stored references from a double representation.

Implements ImFusion::ParameterWrapperBase.

◆ serialize()

template<typename T>
void ImFusion::VectorParameterWrapper< T >::serialize ( double * v) const
overridevirtual

Updates a double representation from the stored references.

Implements ImFusion::ParameterWrapperBase.

◆ name()

template<typename T>
std::string ImFusion::VectorParameterWrapper< T >::name ( int i) const
overridevirtual

Name of the ith parameter, used for display purposes.

Implements ImFusion::ParameterWrapperBase.

◆ clone()

template<typename T>
std::unique_ptr< ParameterWrapperBase > ImFusion::VectorParameterWrapper< T >::clone ( ) const
overridevirtual

Clone function.

Implements ImFusion::ParameterWrapperBase.


The documentation for this class was generated from the following file:
  • ImFusion/Base/ParameterOptimization.h
Search Tab / S to search, Esc to close