OpenCurves  0.9
FunctionUnwrap Class Reference

A function designed to unwrap angles, but capable of unwrapping any range. More...

#include <functionunwrap.h>

Inheritance diagram for FunctionUnwrap:
FunctionDefinition

Public Member Functions

 FunctionUnwrap (const QString &category=QString())
 Constructor. More...
 
void evaluate (PlotFunctionResult &result, double time, unsigned int argc, const double *argv, const PlotFunctionInfo &info, void *context) const override
 Evaluation.
 
- Public Member Functions inherited from FunctionDefinition
 FunctionDefinition (const QString &category, const QString &name, unsigned argc=0, bool variadic=false)
 Construct a function definition. More...
 
 FunctionDefinition (const QString &category, const QString &name, const QString &description, unsigned argc=0, bool variadic=false)
 Construct a function definition. More...
 
virtual ~FunctionDefinition ()
 Virtual destructor.
 
const QString & category () const
 Access the function categorisation for UI grouping. More...
 
void setCategory (const QString &category)
 Set the category name for the function. More...
 
const QString & name () const
 Access the function name as used by the expression generator. More...
 
void setName (const QString &name)
 Set the function name as used by the generator. More...
 
const QString & displayName () const
 Return the function name as displayed with the user. More...
 
void setDisplayName (const QString &name)
 Set the function name as displayed to the user. More...
 
const QString & description () const
 Access the function description. More...
 
void setDesciption (const QString &description)
 Set the function description. More...
 
unsigned argc () const
 Access the minimum argument count. More...
 
void setArgc (unsigned count)
 Set the minimum required arguments. More...
 
bool variadic () const
 Is the function variadic beyond argc()? More...
 
void setVariadic (bool variadic)
 Set the variadic flag. More...
 
virtual void * createContext () const
 Called to create an operating context for calculating function values. More...
 
virtual void destroyContext (void *context) const
 Destroys the context created by createContext(). More...
 
QString deduceDisplayName () const
 Deduces the display name of the function to show usage. More...
 

Detailed Description

A function designed to unwrap angles, but capable of unwrapping any range.

Unwrap turns wrapped plots into continuous plots. For example, consider a rotation in the range [-180, 180] degrees. There can be discontinuities rotating through 180, jumping down to -180. Unwrap converts this into a continuous plot.

The PlotFunctionResult::logicalValue is used to hold the original, wrapped values, while PlotFunctionResult::displayValue is unwrapped.

Constructor & Destructor Documentation

FunctionUnwrap::FunctionUnwrap ( const QString &  category = QString())

Constructor.

Parameters
categoryThe sorting category for this function.

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