Search TipsCamera and Cinematic Controls
Project Graph > Camera:
Further information about the options found when Configuring Cameras and Camera Tracking.
Inputs and Controls
|
Control (UI) |
Knob (Scripting) |
Default Value | Function |
|---|---|---|---|
| Type | CameraType | inner | The type of camera. An inner camera is a typical camera used for rendering from a single point of view, and will normally be linked to a tracked stage camera. An outer camera is a (usually lower resolution) environment map render of the entire scene, used to provide lighting. |
| Enabled | Enabled | ticked | Whether this camera should be rendered. |
| Lock transforms | LockXforms | unticked | If enabled, the camera stream will not be polled to update transforms. This is useful if using a static scene, or a renderer that needs several frames to resolve. |
| Stream | |||
| Type name | TypeName | (none) | The plugin type to instantiate for this object. This list is dynamically populated based on the plugins that are successfully loaded when Nuke Stage starts up. |
| Parameters | |||
| Transform order | TransformOrder | RT | The order in which position (T) and orientation (R) adjustments are applied. Note that no scale (S) adjustment is applied to cameras. |
| Rotation order | Rotationorder | ZXY | The order in which orientation adjustment components are applied, from left to right. |
| Position adjustment | PositionAdjustment | 0.000, 0.000, 0.000 | A constant amount by which to offset the camera’s position. |
| Orientation adjustment | OrientationAdjustment | 0.000, 0.000, 0.000 | A constant amount in Euler angles by which to offset the camera’s orientation, applied in the order specified by TransformOrder. |
| Position multiplier | PositionMultiplier | 1.000, 1.000, 1.000 | A constant amount by which to multiply the camera’s position. |
| F-Stop offset | FStopOffsetAdjustment | 0.000 | Adds a constant offset to F-Stop value. Useful for altering live streamed lens data. |
| F-Stop multiplier | FStopMultiplierAdjustment | 1.000 | Adds a constant multiplier to F-Stop value. Useful for altering live streamed lens data. |
| Focal length offset | FocalLengthOffsetAdjustment | 0.000 | Adds a constant offset to focal length value. Useful for altering live streamed lens data. |
| Focal length multiplier | FocalLengthMultiplierAdjustment | 1.000 | Adds a constant multiplier to focal length value. Useful for altering live streamed lens data. |
| Focus distance offset | FocusDistanceOffsetAdjustment | 0.000 | Adds a constant offset to focus distance value. Useful for altering live streamed lens data. |
| Focus distance multiplier | FocusDistanceMultiplierAdjustment | 1.000 | Adds a constant multiplier to focus distance value. Useful for altering live streamed lens data. |
| Field of view | FovDegrees | 75.000 | The horizontal field of view, in degrees. |
| Aspect ratio | AspectRatio | 16.000, 9.000 | The proportional relationship between the width and height of the image produced by the camera, in pixels. |
| Clip distances | ClipDistances | 0.100, 1000.000 | The near and far clip distances, in meters. |
| Use cinematic parameters | UseCinematicParameters | unticked | When set, the below cinematic parameters will be used instead of fov and aspect ratio. |
| Sensor dimensions | SensorDims | 36.000, 20.250 | Size of the camera sensor, in millimeters. |
| F-stop | F-stop | 16.000 | F-stop of the lens to use. |
| Focal length | Focallength | 23.458 | Focal length of the lens, in millimeters. |
| Squeeze factor | SqueezeFactor | 1.000 | Anamorphic horizontal squeeze factor. |
| Focus distance | FocusDistance | 1.000 | Distance between the lens and focal point, in meters. |
| Additional Parameters- USD | |||
| Filepath | Filepath | N/A | The path of the USD file to load. |
| Primpath | Primpath | N/A | The path to the USD camera prim. |
| Payload | Payload | unticked | If ticked, USD payloads will be loaded alongside the main layer. |
|
Additional Parameters - MoSys (F4) / TCD |
|||
| IP address | IpAdress | 0.0.0.0 | The address on which to receive packets. |
| Port | Port | 5000 | The port on which to receive packets. |
| Camera id | SourceId | 0 | The camera id to connect to. |
|
Additional Parameters - SteamVR |
|||
| Channel | SourceId | 0 | The HMD channel to connect to. |
|
Additional Parameters - Debug |
|||
| Amplitude | Amplitude | 0.400, 0.225, 0.000 | The strength and intensity of the signal captured by the camera. |
| Frequency | Frequency | 16.000, 9.000, 1.000 | Set frequency to minimize flickering. |
| Use playback frametime | UsePlaybackTime | ticked | If enabled, use the project playback frametime to determine camera position. Otherwise a monotonic timer unrelated to project timecode will be used. |
|
Additional Parameters - Vicon |
|||
|
Server address |
ServerAddress | 0.0.0.0 | The network address of the Vicon server to connect to. |
| Stream mode | StreamMode | Client pull prefetch | The data streaming mode. |
| Camera name | CameraName | N/A | The Vicon camera name to connect to. |
| Axis mapping | AxisMapping | X forward, Y up, Z right | The mapping of the axes from Vicon’s coordinate system to Nuke Stage’s coordinate system. |
|
Additional Parameters - Gamepad |
|||
|
Movement speed |
MovementSpeed | 0.100 | The speed at which to translate the camera using the left stick. |
| Rotation speed | RotationSpeed | 0.200 | The speed at which to translate the camera using the right stick. |
| Dead zone | DeadZone | 0.250 | The percentage of each stick’s range to ignore. |
| Channel | SourceId | 0 | The gamepad channel to connect to. |
|
Additional Parameters - FreeD |
|||
| IP address | IpAdress | 0.0.0.0 | The address on which to receive packets. |
| Port | Port | 5000 | The port on which to receive packets. |
| Camera id | SourceId | 0 | The camera id to connect to. |
| Use FreeD lens data | UseFreeDLensInfo | unticked | Whether to use FreeD data for focal length and focus distance or whether to use the user defined parameters. |
| Use camera range | UseCameraRange | ticked | Normalizes Focus Distance, Focal Length and F-Stop with the user- defined min/max. |
| Is valid focus distance | IsValidFocusDistance | ticked | Tells the plugin whether the FreeD packets received have valid focus distance tracking values. |
| Invert encoder focus distance | InvertEncoderFocusDistance | unticked | |
| Use manual range focus distance | UseManualRangeFocusDistance | unticked | When ticked, the plugin will use the user- defined min/max encoded focus distance. Otherwise, min and max will be inferred by the values received. |
| Min focus distance | MinFocusDistance | 0.000 | The min focus distance expressed in centimeters. |
| Max focus distance | MaxFocusDistance | 100000.000 | The max focus distance expressed in centimeters. |
| Min encoded focus distance | MinEncodedFocusDistance | 0 | The min encoded value that the plugin will expect. If ‘UseManualRangeFocusDistance’ is unticked, this user-defined value will be ignored and the smallest encoded value received will be used instead. |
| Max encoded focus distance | MaxEncodedFocusDistance | 16777215 | The max encoded value that the plugin will expect. If Use ManualRangeFocusDistance’ is unticked, this user-defined value will be ignored and the biggest encoded value received will be used instead. |
| Mask bits focus distance | MaskBitsFocusDistance | 16777215 | Mask used on the encoded focus distance value before it is normalized. |
| Is valid focal length | IsValidFocalLength | ticked | Tells the plugin whether the FreeD packets received have valid focal length tracking values. |
| Invert encoder focal length | InvertEncoderFocalLength | unticked | |
| Use manual range focal length | UseManualRangeFocalLength | unticked | When ticked, the plugin will use the user- defined min/max encoded focal length. Otherwise, min and max will be inferred by the values received. |
| Min focal length | MinFocalLength | 4.000 | The min focal length expressed in millimeters. |
| Max focal length | MaxFocalLength | 1000.000 | The max focus distance expressed in millimeters. |
| Min encoded focal length | MinEncodedFocalLength | 0 | The min encoded value that the plugin will expect. If ‘UseManualRangeFocalLength’ is unticked, this user-defined value will be ignored and the smallest encoded value received will be used instead. |
| Max encoded focal length | MaxEncodedFocalLength | 16777215 | The max encoded value that the plugin will expect. If Use ManualRangeFocalLength’ is unticked, this user-defined value will be ignored and the biggest encoded value received will be used instead. |
| Mask bits focal length | MaskBitsFocalLength | 16777215 | Mask used on the encoded focal length value before it is normalized. |
| Is valid F-Stop | IsValidFStop | unticked | Tells the plugin whether the FreeD packets received have valid F-Stop tracking values. |
| Invert encoder F-Stop | InvertEncoderFStop | unticked | |
| Use manual range F-Stop | UseManualRangeFStop | unticked | When ticked, the plugin will use the user- defined min/max encoded F-Stop Otherwise, min and max will be inferred by the values received. |
| Min F-Stop | MinFStop | 1.200 | Minimum F-Stop for this lens (e.g. 2.8 for an f/2.8-f/22 lens) |
| Max F-Stop | MaxFStop | 22.000 | Maximum F-Stop for this lens (e.g. 22 for an f/2.8-f/22 lens) |
| Min encoded F-Stop | MinEncodedFStop | 0 | The min encoded value that the plugin will expect. If ‘UseManualRangeFStop’ is unticked, this user-defined value will be ignored and the smallest encoded value received will be used instead. |
| Max encoded F-Stop | MaxEncodedFStop | 16777215 | The max encoded value that the plugin will expect. If Use ManualRangeFStop’ is unticked, this user-defined value will be ignored and the biggest encoded value received will be used instead. |
| Mask bits F-Stop | MaskBitsFStop | 16777215 | Mask used on the encoded F-Stop value before it is normalized. |
Render
|
Control (UI) |
Knob (Scripting) |
Default Value | Function |
|---|---|---|---|
| Render Order | RenderOrder | 0 | The order in which to render cameras. Cameras with a value higher than other cameras will be rendered on top. |
|
Colour format |
ColourFormat | rgba16f | The texture format to use for this camera’s colour buffer. Larger bitdepths will give greater colour accuracy, but will consume more GPU memory. |
| Depth format | DepthFormat | depth24 | The texture format to use for this camera’s depth buffer. A floating point depth format will give greater precision in scenes with a large depth range, but will consume more GPU memory. |
| Dimension | RawDimension | 1940 x 1080 | The resolution of the camera framebuffer, before any extension. |
| MSAA | NumSamples | 1 | The number of samples per pixel to use for multisample antialiasing. Larger values can reduce pixel artifacts, but will take longer to render and consume more GPU memory. |
| Extension ratio | ExtensionRatio | 0.000 | A fraction by which to extend the camera’s framebuffer, creating a "safety apron" around the viewport that allows hiding camera latency. |
| Feathering | Feathering | 0.000 | The fraction of the ExtensionRatio to soften via alpha blending. |
Debug
|
Control (UI) |
Knob (Scripting) |
Default Value | Function |
|---|---|---|---|
|
Draw border |
DrawDebugBorder | unticked | If enabled, a debug border will be drawn around the camera frustum. |
| Border width | DebugBorderWidth | 10.000 | The width of the debug border, in pixels. |
| Border falloff ratio | DebugBorderFalloff | 0.500 | The amount to feather the debug border by. |
| Border colour | DebugBorderColour | 0.000, 0.000, 1.000, 1.000 | The color of the debug border, if enabled. |
Health
|
Control (UI) |
Knob (Scripting) |
Default Value | Function |
|---|---|---|---|
|
Status |
Status | Uninitialized | The current status of the camera stream. |
