Depth_of_Field : RenderEffect

Depth_of_Field - superclass: renderEffect; super-superclass:MAXWrapper - classID: #(1155882880, 459823346)

Constructor

depth_of_field ...

DOFEffect ...

Properties

<Depth_of_Field>.AffectAlpha Boolean default: true -- alias: Affect_Alpha

 

<Depth_of_Field>.camNodeIndex Integer default: -1 -- alias: Camera_Index

camNodeIndex specifies which camera in the Depth of Field camera dropdown is the selected camera. A value of -1 specifies that no camera is selected. The index is otherwise 0-based.

<Depth_of_Field>.focalNodeIndex Integer default: -1 -- alias: Focal_Index

focalNodeIndex specifies which camera in the Depth of Field focal point node dropdown is the selected focal point node. A value of -1 specifies that no focal point node is selected. The index is otherwise 0-based.

<Depth_of_Field>.FocalPoint Integer default: 0 -- alias: Focal_Point

FocalPoint = 0 - Focal Node; 1 - Use Camera

<Depth_of_Field>.FocalType Integer default: 0 -- alias: Focal_Type

FocalType = 0 - Custom; 1 - Use Camera

<Depth_of_Field>.HorizFocalLoss Float default: 10.0 -- animatable, alias: Horiz_Focal_Loss

 

<Depth_of_Field>.VertFocalLoss Float default: 10.0 -- animatable, alias: Vert_Focal_Loss

 

<Depth_of_Field>.FocalRange Float default: 100.0 -- animatable, alias: Focal_Range

 

<Depth_of_Field>.FocalLimit Float default: 200.0 -- animatable, alias: Focal_Limit

Methods

DOF.addCam <Depth_of_Field> <camera_node_name_string>

Adds the specified camera to the Depth of Field camera dropdown. camera_node_name_string is the name of the camera as a string, and must match the case of the camera’s name. Returns true if the addition was successful, false if it failed. The normal reason for a failure is that the named camera is not present in the scene.

DOF.addFocalNode <Depth_of_Field> <node_name_string>

Adds the specified node to the Depth of Field focal point node dropdown. node_name_string is the name of the node as a string, and must match the case of the node’s name. Returns true if the addition was successful, false if it failed. The normal reason for a failure is that the named node is not present in the scene.

DOF.deleteCam <Depth_of_Field> <index_integer>

Deletes the indexed camera from the Depth of Field camera dropdown, where <index_integer> is the index of the camera in the dropdown. The index is 0-based to maintain consistency with the camNodeIndex property. Returns true if the deletion was successful, false if it failed. The normal reason for a failure is that the indexed camera is not present in the dropdown.

DOF.deleteCamByName <Depth_of_Field> <camera_node_name_string>

Deletes the specified camera from the Depth of Field camera dropdown. camera_node_name_string is the name of the camera as a string, and must match the case of the camera’s name. Returns true if the deletion was successful, false if it failed. The normal reason for a failure is that the named camera is not present in the dropdown.

DOF.deleteFocalNode <Depth_of_Field> <index_integer>

Deletes the indexed node from the Depth of Field focal point node dropdown, where <index_integer> is the index of the node in the dropdown. The index is 0-based to maintain consistency with the focalNodeIndex property. Returns true if the deletion was successful, false if it failed. The normal reason for a failure is that the indexed node is not present in the dropdown.

DOF.deleteFocalNodeByName <Depth_of_Field> <node_name_string>

Deletes the specified node from the Depth of Field focal point node dropdown. node_name_string is the name of the node as a string, and must match the case of the node’s name. Returns true if the deletion was successful, false if it failed. The normal reason for a failure is that the named node is not present in the dropdown.

See also

Render Effects Common Properties, Operators, and Methods

MAXWrapper Common Properties, Operators, and Methods

Value Common Properties, Operators, and Methods