Suite to control timelines. More...

#include <ofxTimeLine.h>

Data Fields
OfxStatus(*	getTime )(void instance, double time)
	Get the time value of the timeline that is controlling to the indicated effect.
OfxStatus(*	gotoTime )(void *instance, double time)
	Move the timeline control to the indicated time.
OfxStatus(*	getTimeBounds )(void instance, double firstTime, double *lastTime)
	Get the current bounds on a timeline.

Detailed Description

Suite to control timelines.

This suite is used to enquire and control a timeline associated with a plug-in instance.

This is an optional suite in the Image Effect API.

Definition at line 45 of file ofxTimeLine.h.

Field Documentation

OfxStatus( * OfxTimeLineSuiteV1::getTime)(void *instance, double *time)

Get the time value of the timeline that is controlling to the indicated effect.

instance - is the instance of the effect changing the timeline, cast to a void *
time - a pointer through which the timeline value should be returned

This function returns the current time value of the timeline associated with the effect instance.

Returns:

kOfxStatOK - the time enquiry was sucessful
kOfxStatFailed - the enquiry failed for some host specific reason
kOfxStatErrBadHandle - the effect handle was invalid

Definition at line 59 of file ofxTimeLine.h.

OfxStatus( * OfxTimeLineSuiteV1::getTimeBounds)(void *instance, double *firstTime, double *lastTime)

Get the current bounds on a timeline.

instance - is the instance of the effect changing the timeline, cast to a void *
firstTime - is the first time on the timeline. This is in the temporal coordinate system of the effect.
lastTime - is last time on the timeline. This is in the temporal coordinate system of the effect.

This function

Returns:

kOfxStatOK - the time enquiry was sucessful
kOfxStatFailed - the enquiry failed for some host specific reason
kOfxStatErrBadHandle - the effect handle was invalid

Definition at line 91 of file ofxTimeLine.h.

Referenced by OFX::ImageEffect::timeLineGetBounds().

OfxStatus( * OfxTimeLineSuiteV1::gotoTime)(void *instance, double time)

Move the timeline control to the indicated time.

instance - is the instance of the effect changing the timeline, cast to a void *
time - is the time to change the timeline to. This is in the temporal coordinate system of the effect.

This function moves the timeline to the indicated frame and returns. Any side effects of the timeline change are also triggered and completed before this returns (for example instance changed actions and renders if the output of the effect is being viewed).

Returns:

kOfxStatOK - the time was changed sucessfully, will all side effects if the change completed
kOfxStatFailed - the change failed for some host specific reason
kOfxStatErrBadHandle - the effect handle was invalid
kOfxStatErrValue - the time was an illegal value

Definition at line 76 of file ofxTimeLine.h.

Referenced by OFX::ImageEffect::timeLineGotoTime().

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

libraries/openfxHack/include/ofxTimeLine.h

Data Fields

Detailed Description

Field Documentation