camera.h File Reference

#include "ofxImageEffect.h"

Include dependency graph for camera.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	NukeOfxCameraSuiteV1
	A suite to use Nuke cameras. More...
Defines
#define	kNukeOfxCameraSuite   "NukeOfxCameraSuite"
	string to identify the Camera suite, pass to OfxHost::fetchSuite
#define	kNukeOfxCameraProjectionModePerspective   0.0
#define	kNukeOfxCameraProjectionModeOrthographic   1.0
#define	kNukeOfxCameraProjectionModeUV   2.0
#define	kNukeOfxCameraProjectionModeSpherical   3.0
#define	kNukeOfxCameraParamProjectionMode   "projection_mode"
	Name of the projection mode nuke camera parameter.
#define	kNukeOfxCameraParamFocalLength   "focal"
	Name of the focal length nuke camera parameter.
#define	kNukeOfxCameraParamHorizontalAperture   "haperture"
	Name of the horizontal aperture nuke camera parameter.
#define	kNukeOfxCameraParamVerticalAperture   "vaperture"
	Name of the vertical aperture nuke camera parameter.
#define	kNukeOfxCameraParamNear   "near"
	Name of the near clipping plane nuke camera parameter.
#define	kNukeOfxCameraParamFar   "far"
	Name of the far clipping plane nuke camera parameter.
#define	kNukeOfxCameraParamWindowTranslate   "win_translate"
	Name of the window translate nuke camera parameter.
#define	kNukeOfxCameraParamWindowScale   "win_scale"
	Name of the window scale nuke camera parameter.
#define	kNukeOfxCameraParamWindowRoll   "winroll"
	Name of the window roll scale nuke camera parameter.
#define	kNukeOfxCameraParamFocalPoint   "focal_point"
	Name of the focal point nuke camera parameter.
#define	kNukeOfxCameraParamPositionMatrix   "position_matrix"
	Name of the camera position parameter.
Typedefs
typedef struct NukeOfxCameraStruct *	NukeOfxCameraHandle
typedef struct NukeOfxCameraSuiteV1	NukeOfxCameraSuiteV1
	A suite to use Nuke cameras.

---

Define Documentation

#define kNukeOfxCameraParamFar   "far"

Name of the far clipping plane nuke camera parameter.

This has only one dimension.

Definition at line 103 of file camera.h.

#define kNukeOfxCameraParamFocalLength   "focal"

Name of the focal length nuke camera parameter.

This has only one dimension.

Definition at line 79 of file camera.h.

#define kNukeOfxCameraParamFocalPoint   "focal_point"

Name of the focal point nuke camera parameter.

This has only one dimension.

Definition at line 127 of file camera.h.

#define kNukeOfxCameraParamHorizontalAperture   "haperture"

Name of the horizontal aperture nuke camera parameter.

This has only one dimension.

Definition at line 85 of file camera.h.

#define kNukeOfxCameraParamNear   "near"

Name of the near clipping plane nuke camera parameter.

This has only one dimension.

Definition at line 97 of file camera.h.

#define kNukeOfxCameraParamPositionMatrix   "position_matrix"

Name of the camera position parameter.

This represents a homogenous 4x4 transform matrix that places the camera in 3D space. As such it has 16 values.

Definition at line 134 of file camera.h.

#define kNukeOfxCameraParamProjectionMode   "projection_mode"

Name of the projection mode nuke camera parameter.

This has only one dimension and can be one of four values...

• kNukeOfxCameraProjectionPerspective
• kNukeOfxCameraProjectionOrthographic
• kNukeOfxCameraProjectionUV
• kNukeOfxCameraProjectionSpherical

Definition at line 73 of file camera.h.

#define kNukeOfxCameraParamVerticalAperture   "vaperture"

Name of the vertical aperture nuke camera parameter.

This has only one dimension.

Definition at line 91 of file camera.h.

#define kNukeOfxCameraParamWindowRoll   "winroll"

Name of the window roll scale nuke camera parameter.

This has one dimension.

Definition at line 121 of file camera.h.

#define kNukeOfxCameraParamWindowScale   "win_scale"

Name of the window scale nuke camera parameter.

This has two dimensions.

Definition at line 115 of file camera.h.

#define kNukeOfxCameraParamWindowTranslate   "win_translate"

Name of the window translate nuke camera parameter.

This has two dimensions.

Definition at line 109 of file camera.h.

#define kNukeOfxCameraProjectionModeOrthographic   1.0

Definition at line 61 of file camera.h.

#define kNukeOfxCameraProjectionModePerspective   0.0

Definition at line 60 of file camera.h.

#define kNukeOfxCameraProjectionModeSpherical   3.0

Definition at line 63 of file camera.h.

#define kNukeOfxCameraProjectionModeUV   2.0

Definition at line 62 of file camera.h.

#define kNukeOfxCameraSuite   "NukeOfxCameraSuite"

string to identify the Camera suite, pass to OfxHost::fetchSuite

Definition at line 56 of file camera.h.

Referenced by OFX::Private::loadAction().

---

Typedef Documentation

typedef struct NukeOfxCameraStruct* NukeOfxCameraHandle

Definition at line 58 of file camera.h.

typedef struct NukeOfxCameraSuiteV1 NukeOfxCameraSuiteV1

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)