ADC Home > Reference Library > Reference > Apple Applications > Final Cut Pro/Final Cut Express > FxPlug Reference

Fx3DAPI

Declared In:

Introduction

Defines the methods the host application provides to get information about the 3D environment, including camera and object transforms.

Methods

-cameraMatrixAtTime:: Gets the 4x4 camera transform matrix.
-focalLengthAtTime:: Gets the focal length.
-is3D: Indicates whether or not the effect's layer is in 3D.
-layerMatrixAtTime:: Gets the 4x4 layer transform matrix.

cameraMatrixAtTime:

Gets the 4x4 camera transform matrix.

- (NSData*)cameraMatrixAtTime:(double)time;

Parameters

time: Specified time, expressed in canonical frames, to retrieve the matrix value.

Return Value

An NSData object that wraps 16 double floating-point values. Those values can be retrieved with a call to [theData getBytes:&anArrayOf16Doubles];

focalLengthAtTime:

Gets the focal length.

- (double)focalLengthAtTime:(double)time;

Parameters

time: Specified time, expressed in canonical frames, to retrieve the matrix value.

Return Value

The value of the focal length.

is3D

Indicates whether or not the effect's layer is in 3D.

- (BOOL)is3D;

Return Value

YES if the layer is 3D, NO otherwise.

layerMatrixAtTime:

Gets the 4x4 layer transform matrix.

- (NSData*)layerMatrixAtTime:(double)time;

Parameters

time: Specified time, expressed in canonical frames, to retrieve the matrix value.

Return Value

An NSData object that wraps 16 double floating-point values. Those values can be retrieved with a call to [theData getBytes:&anArrayOf16Doubles];

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-06-05