C3D Toolkit  Kernel - 118069, Vision - 2.16.7.1844
MbTransitionMarker Class Reference

A transition marker. More...

#include <function_factory.h>

Public Types

enum class  TransitionType { Linear = 0 , Blend = 1 , Minmax = 2 }
 The transition type. More...
 

Public Member Functions

 MbTransitionMarker (const double t, const double value, const TransitionType transition)
 Constructor. More...
 
double GetPosition () const
 < Return a marker's position.
 
double GetValue () const
 Return value.
 
TransitionType GetTransition () const
 Return transition type.
 

Detailed Description

A transition marker.

A marker's position is specified by m_position. The transition type m_transition sets the function's behavior in the interval immediately following the marker to the right: Linear - a linear function, Blend - a smooth spline function with a continuous first derivative, Minmax - a spline function with a fixed zero first derivative to the right of the marker point (df(t)/dt = 0, at t = m_position+0). For the final marker, the Minmax transition type will set the derivative value to zero to the left of the last point, provided the preceding marker has a Blend or Minmax type.

Member Enumeration Documentation

◆ TransitionType

The transition type.

Enumerator
Linear 

Linear.

Blend 

Spline.

Minmax 

Spline with zero derivative.

Constructor & Destructor Documentation

◆ MbTransitionMarker()

MbTransitionMarker::MbTransitionMarker ( const double  t,
const double  value,
const TransitionType  transition 
)
inlineexplicit

Constructor.

Constructor by parameters.

Parameters
[in]t- A marker's position.
[in]value- Value.
[in]transition- Transition type.

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