MeVisLab Scripting Reference
MLKeyFrameListWrapper Class Reference

#include <mlKeyFrameListWrapper.h>

Inherits QObject.

Public Slots

QObject * getFrame (int position) const
 
QList< QObject * > getFrames () const
 
List modifying methods. These need a touch on the owning field to propagate the changes.
QObject * addFrame (const QVariantList &pos, const QVariantList &tangent, const QVariantList &up)
 
QObject * insertFrame (int index, const QVariantList &pos, const QVariantList &tangent, const QVariantList &up)
 
void removeFrame (int index)
 
size_t size () const
 

Detailed Description

A class that wraps KeyFrameList objects for use in Scripting.

Member Function Documentation

◆ addFrame

QObject * MLKeyFrameListWrapper::addFrame ( const QVariantList & pos,
const QVariantList & tangent,
const QVariantList & up )
slot

Add a new MLKeyFrameWrapper at the end of the list.

You must provide the position, tangent vector, and up vector as lists/tuples of three numeric values.

◆ getFrame

QObject * MLKeyFrameListWrapper::getFrame ( int position) const
slot

Get the MLKeyFrameWrapper for a certain position.

◆ getFrames

QList< QObject * > MLKeyFrameListWrapper::getFrames ( ) const
slot

Get a list of MLKeyFrameWrapper.

◆ insertFrame

QObject * MLKeyFrameListWrapper::insertFrame ( int index,
const QVariantList & pos,
const QVariantList & tangent,
const QVariantList & up )
slot

Insert a new MLKeyFrameWrapper at the given index.

Arguments are the same as above plus the position where the frame is inserted in the list.

◆ removeFrame

void MLKeyFrameListWrapper::removeFrame ( int index)
slot

Remove the key frame at the given position in the list. Note that the wrapper for this key frame also gets removed at this point.

◆ size

size_t MLKeyFrameListWrapper::size ( ) const
slot

Get number of key frames in the list.