Camera Info

class lwsdk.LWCameraInfo(self)

Bases: object

Proxy of C++ PCore::LWCameraInfo class

 antiAliasing(LWItemID camera, LWTime time) → unsigned int

Return the antialiasing level for the camera.

 blurLength(LWItemID camera, LWTime time) → double

Returns the blur length as a fraction of the frame time.

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

 convergencePoint(LWItemID camera, LWTime time) → double

Returns the convergence point(zero parallax) for stereoscopic rendering, in meters.

 convergenceToeIn(LWItemID camera, LWTime time) → double

Returns the convergence toe-in fraction for stereoscopic rendering.

 diaphragm(LWItemID camera, LWTime time) → (sides, rotation)

Gets the number of sides and rotation of the diaphragm for the camera. If the number of sides is zero, the diaphragm is circular. The rotation is in radians.

 eyeTransform(LWItemID camera, LWTime time, LWCameraEye eye) → (mot[3], convergence_point[3], convergence_distance, delta_rotm[9], delta_shear[2], delta_pos[3])

Returns information about the stereo camera setup. eye is one of lwsdk.LWCAMEYE_CENTER, lwsdk.LWCAMEYE_LEFT, or lwsdk.LWCAMEYE_RIGHT. Information about that eye is returned.

The mot array contains the eye's XYZ position, HPB rotation, and XYZ scale values (in that order) in world coordinates.

The convergence_point is the position of the convergence point in world coordinates. The convergence_distance is the distance of the convergence point from the center eye. The convergence point and distance values are only valid when requesting information for the left or right eye. In the case where a parallel stereo setup is used, the convergence distance will be lwsdk.FLT_MAX with the convergence point left undefined.

delta_rotm is the rotation matrix transforming from the center eye coordinate system to the requested eye coordinate system. delta_shear is the shear applied to the projection, given as X and Y offsets at unit distance along Z in the center eye coordinate system. delta_pos is the position of the eye relative to the center eye in the world coordinate system.

 fStop(LWItemID camera, LWTime time) → double

Returns the f-stop number.

 fieldRendering(LWItemID camera) → unsigned int

Returns the field-rendering state for the specified camera. See the lwsdk.LWCAMFIELDR_ defines for possible return values.

lwsdk.LWCAMFIELDR_OFF
lwsdk.LWCAMFIELDR_EVENFIRST
lwsdk.LWCAMFIELDR_ODDFIRST

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

 filmSize(LWItemID camera) → (width, height)

Gets the width and height of the film frame in metres.

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

 flags(LWItemID camera) → unsigned int

Returns flags describing the camera, combined using bitwise-or:

  lwsdk.LWCAMF_STEREO
    This indicates that the camera has stereo rendering enabled.
  lwsdk.LWCAMF_LIMITED_REGION
    This indicates that the camera has limited region rendering set.
  lwsdk.LWCAMF_MASK
    This indicates that masked rendering is enabled for the camera.
  lwsdk.LWCAMF_DOF
    This indicates that the camera has enabled depth of field.
  lwsdk.LWCAMF_PARTICLE_BLUR
    This indicates that the camera has enabled particle blurring, which is the simulated trajectory of one-point polygons over time
  lwsdk.LWCAMF_LR_NOBORDERS
    This indicates that limited region is being used without borders when limited region is enabled
  lwsdk.LWCAMF_FIELD
    When field rendering is enabled, this indicates which field (0 or 1) is being processed
  lwsdk.LWCAMF_USECAMTYPE
    Indicates that the camera uses a camera type plugin, instead of the built-in classic type (rev.4+)
  lwsdk.LWCAMF_SUPPORTS_DOF
    Set when the camera supports Depth of Field rendering. Check LWCAMF_DOF to determine if DOF is enabled or not (rev.5+)
  lwsdk.LWCAMF_EYE
    When stereo rendering is enabled, this indicates which eye (0 or 1) is being processed (rev.5+)

NOTE: The lwsdk.LWCAMF_PARTICLE_BLUR and lwsdk.LWCAMF_FIELD flags are controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

 focalDistance(LWItemID camera, LWTime time) → double

Returns the distance from the camera at which objects are in focus.

 focalLength(LWItemID camera, LWTime time) → double

Returns the focal length in millimeters.

 fovAngles(LWItemID camera, LWTime time) → (hfov, vfov)

Returns the hfov and vfov (horizontal and vertical field of view) angles, expressed in radians.

 frameTiming(LWItemID camera, LWFrame frame, timingInfo) → unsigned int

!! NOT IMPLEMENTED !!

 irisPos(LWItemID camera, LWTime time, int _pass) → (result, ix, iy)

Returns the iris position for the camera at a given time and pass number. The iris position is typically used for depth of field. It represents a sample point on the camera's aperture. The position is normalized, ranging from -1 to 1 over the height of the aperture. The pass number ranges from 0 to sceneinfo->maxSamplesPerPixel-1. result will be 1 if there is a sample point, or 0 otherwise.

 maskColor(LWItemID camera) → color[3]

Returns the color that will be rendered in areas of the image outside the mask rectangle.

 maskLimits(LWItemID camera) → (x0, y0, x1, y1)

Returns the mask rectangle for the camera.

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

maxSamples(self, LWItemID arg1, LWTime arg2) → unsigned int
minSamples(self, LWItemID arg1, LWTime arg2) → unsigned int
 motionBlur(LWItemID camera) → unsigned int

This retrieves motion blur setting for a camera item. See the lwsdk.LWCAMMB_ defines for possible return values. This value is only valid when a multi-pass anti-aliasing approach is used.

lwsdk.LWCAMMB_OFF
lwsdk.LWCAMMB_NORMAL
lwsdk.LWCAMMB_DITHERED
lwsdk.LWCAMMB_PHOTOREAL

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

 motionBlurPasses(LWItemID camera, LWTime time) → unsigned int

This retrieves the motion blur passes setting for a camera item.

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

 noiseSampler(LWItemID camera) → unsigned int

Returns the noise sampler setting for the camera.

 overSampling(LWItemID camera, LWTime time) → double

Returns the oversampling value for the camera.

overscanMode(self, LWItemID arg1) → LWCameraOverscan
overscanSize(self, LWItemID arg1) → LWCameraOverscan
 pixelAspect(LWItemID camera, LWTime time) → double

Returns the pixel aspect ratio of images rendered by the camera, expressed as width/height. Values greater than 1.0 mean short wide pixels and values less than 1.0 mean tall thin pixels.

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

 regionLimits(LWItemID camera) → (x0, y0, x1, y1)

Gets the limited region rectangle for the camera.

 resolution(LWItemID camera) → (width, height)

Gets the image size in pixels for the images rendered by the camera.

NOTE: This setting is controlled by a "Use Global" flag (see LWCameraInfo::usingGlobalBlur()). If the camera's "Use Global" flag is enabled for this setting, then the value returned by this function comes instead from the scene's Global Camera.

rollingShutter(self, LWItemID arg1, LWTime arg2) → double
 separation(LWItemID camera, LWTime time) → double

Returns the interocular distance (eye separation) for stereoscopic rendering, in meters.

 shutterEfficiency(LWItemID camera, LWTime time) → double

Gets the shutter efficiency for a camera item. The efficiency is returned as a fraction, usually between 0.5 and 1.0.

shutterOpen(self, LWItemID arg1, LWTime arg2) → double
trackedEye(self, LWItemID arg1) → LWCameraEye
 usingConvergencePoint(LWItemID camera) → int

Returns 1 if the convergence point setting is being used, 0 otherwise.

 usingGlobalBlur(LWItemID camera) → int

Reports the state of the Camera's "Use Global" redirection flag for motion blur settings. A value of 1 means the switch is enabled, and the global motion blur settings are used by this camera. A value of 0 means it is off, and the camera's local motion blur settings are active.

 usingGlobalMask(LWItemID camera) → int

Reports the state of the Camera's "Use Global" redirection flag for mask boundary settings. A value of 1 means the switch is enabled, and the global mask boundary settings are used by this camera. A value of 0 means it is off, and the camera's local mask boundary settings are active.

NOTE: Mask boundaries are only regarded if "Use Mask" has been enabled.

 usingGlobalResolution(LWItemID camera) → int

Reports the state of the Camera's "Use Global" redirection flag for resolution settings. A value of 1 means the switch is enabled, and the global resolution settings are used by this camera. A value of 0 means it is off, and the camera's local resolution settings are active.

 zoomFactor(LWItemID camera, LWTime time) → double

Returns the zoom factor.

Previous topic

Light Info

Next topic

Camera Evaluation Funcs

This Page