Ignition Common

API Reference

4.5.0
NumericKeyFrame Class Reference

A keyframe for a NumericAnimation. More...

#include <KeyFrame.hh>

Public Member Functions

 NumericKeyFrame (const double _time)
 Constructor. More...
 
virtual ~NumericKeyFrame ()
 Destructor. More...
 
void Value (const double &_value)
 Set the value of the keyframe. More...
 
const double & Value () const
 Get the value of the keyframe. More...
 
- Public Member Functions inherited from KeyFrame
 KeyFrame (const double _time)
 Constructor. More...
 
virtual ~KeyFrame ()
 Destructor. More...
 
double Time () const
 Get the time of the keyframe. More...
 

Detailed Description

A keyframe for a NumericAnimation.

Constructor & Destructor Documentation

◆ NumericKeyFrame()

NumericKeyFrame ( const double  _time)
explicit

Constructor.

Parameters
[in]_timeTime of the keyframe

◆ ~NumericKeyFrame()

virtual ~NumericKeyFrame ( )
virtual

Destructor.

Member Function Documentation

◆ Value() [1/2]

void Value ( const double &  _value)

Set the value of the keyframe.

Parameters
[in]_valueThe new value

◆ Value() [2/2]

const double& Value ( ) const

Get the value of the keyframe.

Returns
the value of the keyframe

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