OfxTimeLineSuiteV1 Struct Reference

#include <ofxTimeLine.h>

List of all members.

---

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.

Public Attributes
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.

---

Member Data 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

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

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

---

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

• ofxTimeLine.h

---

Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:

1. Redistributions of the document must retain the above copyright notice and this list of conditions.
2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

Automatic documentation generated by DOxygen.