camera

Go to: Related nodes. Attributes.

Related nodes

light, dropoffLocator, ambientLight, nonAmbientLightShapeNode, nonExtendedLightShapeNode, areaLight, directionalLight, spotLight, pointLight

Attributes (95)

Attribute quick index omitted (too many attributes to show them all).

Long name (short name)	Type	Default	Flags
autoSetPivot (asp)	bool	0
Pivot is automatically set by tools
backgroundColor (col)	float3
background color
backgroundColorR (colr) float 0.0 background R value
backgroundColorG (colg) float 0.0 background G value
backgroundColorB (colb) float 0.0 background B value
bestFitClippingPlanes (bfc)	bool	true
Activate manual clipping planes for rendering
bookmarks (b)	Message	n/a
Connections to the camera views.
cameraAperture (cap)	double2	3.6cm 2.4cm
Camera aperture (inches)
horizontalFilmAperture (hfa) double 0.0 Horizontal camera aperture (inches)
verticalFilmAperture (vfa) double 0.0 Vertical camera aperture (inches)
locatorScale (lls)	double	1.0
Scales factor for the camera locator.
cameraPrecompTemplate (cpt)	string	TmultiSharedObject::create<TdataString>""
File path of Pre-Compositing Template for camera
cameraScale (cs)	double	1.0
Scale of the camera focal length for simulating differently sized cameras without changing other attributes.
centerOfInterest (coi)	distance (double)	5.0cm
Distance to the center of interest (object space)
clippingPlanes (cp)	bool	true
Unused attribute; will be removed in a future release
useExploreDepthFormat (uexd)	bool	false
Use explore format for depth output, something we will delete eventually.
depth (dep)	bool	false
Activate depth output
depthName (den)	string	NULL
Depth name
depthOfField (dof)	bool	false
Activate the depth of field effect
depthType (dptp)	enum	1
Depth output based on 0: closest visible or 1:furthest visible object
displayCameraFarClip (cfp)	bool	false
Control the display of far clipping plane.
displayCameraFrustum (dcf)	bool	false
Control the display of frustum.
displayCameraNearClip (cnc)	bool	false
Control the display of near clipping plane.
displayFieldChart (dfc)	bool	false
Display the video field chart
displayFilmGate (dfg)	bool	false
Display the icons to show the film gate
displayFilmOrigin (dfo)	bool	false
Display the location of the origin on the filmback.
displayFilmPivot (dfp)	bool	false
Display the film back pivot point
displayGateMask (dgm)	bool	true
Display the gate mask, file or resolution, as shaded
displayGateMaskColor (dgc)	float3
display gate mask color
displayGateMaskColorR (dgcr) float 0.5 display gate mask color R value
displayGateMaskColorG (dgcg) float 0.5 display gate mask color G value
displayGateMaskColorB (dgcb) float 0.5 display gate mask color B value
displayGateMaskOpacity (dgo)	float	0.7
Opacity of the display gate mask, as a percentage
displayResolution (dr)	bool	false
Display the icons to show the rendering resolution
displaySafeAction (dsa)	bool	false
Display the video safe action area
displaySafeTitle (dst)	bool	false
Display the video safe title area
fStop (fs)	double	5.6
Set the camera F/Stop
farClipPlane (fcp)	distance (double)	10000.0cm
Distance from the camera to the far clipping plane (object space)
filmFit (ff)	enum	1
Match the view to film aspect ratio using a: 0 fill, 1 horizontal, 2 vertical, 3 overscan fit.
filmFitOffset (ffo)	double	0.0
Amount to move the smaller image within the larger one (inches)
filmOffset (fio)	double2	0.0, 0.0
Film back offset (inches)
horizontalFilmOffset (hfo) double 0.0 Horizontal film back offset (inches)
verticalFilmOffset (vfo) double 0.0 Vertical film back offset (inches)
focalLength (fl)	double	35.0
Camera focal length in millimeters
focusDistance (fd)	distance (double)	5.0cm
Distance to the focus point
focusRegionScale (frs)	double	1.0
scale factor applied to the focus distance and the value of each DOF depth image pixel during the Depth-of-Field computation
homeCommand (hc)	string	NULL
Command to get a camera back to its home position
image (img)	bool	true
Activate image output
imageName (imn)	string	NULL
Image name
imagePlane (ip)	Message	n/a
Connection to the image planes
journalCommand (jc)	bool	false
Activate journaling
lensSqueezeRatio (lsr)	double	1.0
Lens squeeze ratio
mask (ma)	bool	true
Activate mask output
maskName (man)	string	NULL
Mask name
motionBlur (mb)	bool	false
Activate the motion blur effect
nearClipPlane (ncp)	distance (double)	0.1cm
Distance from the camera to the near clipping plane (object space)
orthographic (o)	bool	false
Activate the orthographic projection
orthographicWidth (ow)	distance (double)	10.0cm
Distance of the orthographic width
overscan (ovr)	double	1.0
The percent over the film viewable frustum to display
pan (pn)	double2	0.0, 0.0
2D camera pan (inches)
horizontalPan (hpn) double 0.0 Horizontal 2d camera pan (inches)
verticalPan (vpn) double 0.0 Vertical 2d camera pan (inches)
panZoomEnabled (pze)	bool	false
Use 2D camera pan and zoom
postProjection (ppj)	compound	n/a
This compound holds the post projection attributes that are used to define the post projection matrix. After the projection matrix is computed these attributes define how the projected image is ultimately displayed.
preScale (psc) double 1.0 Scale factor. First component added to the projection matrix.
filmTranslate (ct) double2 0.0, 0.0 Post projection translation component. Translate the film back by the given values. The values are normalized with respect to viewing area. filmTranslateH (fth) double 0.0 Translate in horizontal direction. filmTranslateV (ftv) double 0.0 Translate in vertical direction.
filmRollControl (frc) compound n/a Film back roll control. This compound contains the attributes that control the rotation of the projected image in the 3d view. filmRollPivot (frp) double2 0.0, 0.0 The 2D point on the projected image to rotate film back around. These values are normalized to the viewing area of the camera. horizontalRollPivot (hrp) double 0.0 Horizontal roll pivot. verticalRollPivot (vrp) double 0.0 Vertical roll pivot. filmRollValue (frv) angle (double) 0.0deg Roll value. The amount of rotation to apply to the film back. filmRollOrder (fro) enum 0 The order in which to apply the rotation with respect to the filmTranslate, rotate-translate or translate-rotate. rotate-translate implies that the rotate will occur before the translation, and the translate-rotate implies that the translation will occur before the rotation.
postScale (ptsc) double 1.0 Scale factor applied after all of the other pre-projection attributes have been applied.
renderPanZoom (rpz)	bool	false
Use 2D camera pan and zoom in render
renderable (rnd)	bool	true
If this camera is to be rendered
shake (shk)	double2	0.0, 0.0
Camera Shake offset (inches)
horizontalShake (hs) double 0.0 Horizontal camera shake offset (inches)
verticalShake (vs) double 0.0 Vertical camera shake offset (inches)
shakeEnabled (se)	bool	false
Camera Shake attribute toggle When true, the cameraShake values are added to the film offset values. Otherwise they are ignored.
shakeOverscan (sos)	double	1.0
Camera rendered overscan for camera shake
shakeOverscanEnabled (soe)	bool	false
Camera Shake Overscan toggle When true, the shakeOverscan value is multiplied to the film aperture values. Otherwise they are ignored.
shutterAngle (sa)	angle (double)	144.0deg
The shutter angle for motion blur
stereoHorizontalImageTranslate (hit)	double	0.0
Film Back offset (inches) for stereo. This attribute is useful only when you have a stereo camera rig setup. Stereo camera rigs involve more than one camera (i.e. leftCam and rightCam) and this attribute can be used to control the stereo point of zero parallax between the two cameras. Generally, it should not be used in a single camera setup.
stereoHorizontalImageTranslateEnabled (hte)	bool	false
Toggles the stereoHIT attribute's contribution.
threshold (tthd)	double	0.9
Threshold of the transparency value used for transparency based depth output
transparencyBasedDepth (tdth)	bool	true
Activate Transparency based depth output
triggerUpdate (tu)	double	0.0
Trigger an update, which includes refreshing of any active viewports. By dirtying this attribute, an update will be triggered. You can connect an output attribute from some other node that needs to trigger an update to this attribute. The actual value has no meaning: its the fact that it gets set that triggers the update.
tumblePivot (tp)	double3	0.0, 0.0, 0.0
World point to tumble about (world space)
tumblePivotX (tpx) double 0.0 World X to tumble about
tumblePivotY (tpy) double 0.0 World Y to tumble about
tumblePivotZ (tpz) double 0.0 World Z to tumble about
usePivotAsLocalSpace (uls)	bool	0
How this camera wants to be tumbled: false to use the setting from the tumble tool, and true to tumble about the camera's axis.
zoom (zom)	double	1.0
The ratio over the film viewable frustum to display