NukeOfxCameraSuiteV1 Struct Reference

A suite to use Nuke cameras. More...

#include <camera.h>

Data Fields
OfxStatus(*	cameraDefine )(OfxImageEffectHandle pluginHandle, const char *name, OfxPropertySetHandle *propertySet)
	Define a camera input to an effect.
OfxStatus(*	cameraGetHandle )(OfxImageEffectHandle pluginHandle, const char *name, NukeOfxCameraHandle *camera, OfxPropertySetHandle *propertySet)
	Get the handle of the named camera input to an effect.
OfxStatus(*	cameraGetPropertySet )(NukeOfxCameraHandle camera, OfxPropertySetHandle *propHandle)
	Get the property set for the given camera.
OfxStatus(*	cameraGetParameter )(NukeOfxCameraHandle camera, const char *paramName, double time, int view, double *baseReturnAddress, int returnSize)
	Get an arbitrary camera parameter for a given time and view.

---

Detailed Description

A suite to use Nuke cameras.

This suite provides the functions needed by a plugin to define and use camera inputs for a Nuke image effect plugin.

Cameras are named and more than one camera can be attached as an input to an effect.

Camera descriptor property sets are defined to have the following properties

• kOfxPropType - (read only) set to "NukeCamera"
• kOfxPropName - (read only) the name the camera was created with
• kOfxPropLabel - (read/write) the user visible label for the camera
• kOfxPropShortLabel - (read/write)
• kOfxPropLongLabel - (read/write)
• kOfxImageClipPropOptional - (read/write)

Instance property sets have all the descriptor properties (as read only) and the following properties...

• kOfxImageClipPropConnected - (read only)

Definition at line 153 of file camera.h.

---

Field Documentation

OfxStatus(* NukeOfxCameraSuiteV1::cameraDefine)(OfxImageEffectHandle pluginHandle, const char *name, OfxPropertySetHandle *propertySet)

Define a camera input to an effect.

• pluginHandle - the decriptor handle passed into the 'describeInContext' action
• name - unique name of the camera to define
• propertySet - a property handle for the camera descriptor will be returned here

Called by the plugin when the 'describeInContext' action has been called. Sets up a camera input with the given name. If not NULL, then a pointer to a PropertySetHandle for the Camera may be put in *propertySet.

More than one camera can be defined, they will need different names.

Definition at line 166 of file camera.h.

OfxStatus(* NukeOfxCameraSuiteV1::cameraGetHandle)(OfxImageEffectHandle pluginHandle, const char *name, NukeOfxCameraHandle *camera, OfxPropertySetHandle *propertySet)

Get the handle of the named camera input to an effect.

• pluginHandle - an instance handle to the plugin
• name - name of camera, previously used in a camera define call
• camera - where to return the camera handle
• propertySet - if not null, the descriptor handle for the camera's property set will be placed here.

Definition at line 175 of file camera.h.

Referenced by OFX::ParamSet::fetchRawCameraParam().

OfxStatus(* NukeOfxCameraSuiteV1::cameraGetParameter)(NukeOfxCameraHandle camera, const char *paramName, double time, int view, double *baseReturnAddress, int returnSize)

Get an arbitrary camera parameter for a given time and view.

• camera - the handle of the camera, as obtained from cameraGetHandle
• time - the time to evaluate the parameter for
• view - the view to evaluate the parameter for
• paramName - parameter name to look up (matches name of knob in Nuke, see defines at top of ofxCamera::h)
• baseReturnAddress - base address to store the evaluated result
• returnSize - the number of doubles at the baseReturnAddress

Returns:

• kOfxStatOK - if the parameter was fetched succesfully
• kOfxStatFailed - if the camera was not connected
• kOfxStatErrUnknown - if the named parameter could not be found

Definition at line 198 of file camera.h.

OfxStatus(* NukeOfxCameraSuiteV1::cameraGetPropertySet)(NukeOfxCameraHandle camera, OfxPropertySetHandle *propHandle)

Get the property set for the given camera.

• camera - the handle of the camera, as obtained from cameraGetHandle
• propertySet - will be set with a pointer to the property set

Definition at line 182 of file camera.h.

---

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

• libraries/openfxHack/include/extensions/nuke/camera.h