Render Effects Common Properties, Operators, and Methods

Render Effects have the following common properties and methods:

Properties

.name String default: varies

The name as it appears in the Rendering/Effects dialog list. The class name is used as the default name when no name: creation parameter is supplied.

Methods

addEffect

Adds the render effect to the Rendering/Effects dialog list.

setActive

Sets the render effect active or inactive. If is true the render effect is set to active; if false, inactive.

Associated Methods and Global Variables

You can use the following global variables and functions for maintaining the list of render effects in the Rendering/Effects dialog list:

IsActive

Returns true if the render effect is set to active; false otherwise.

numEffects

Global variable containing an Integer value that defines the number of current render effects defined in the Rendering/Effects dialog list. This variable is read-only.

getEffect

Retrieves the render effect at the indexed position in the Rendering/Effects dialog list. The index is 1-based.

editEffect [ gizmo: ]

Opens the Rendering/Effects dialog, and opens the rollout for the specified render effect if it has been added to the Render Effects list. If the optional gizmo: argument is specified, and the specified node is a gizmo for the render effect, that gizmo is selected in the render effect’s gizmo list.

In 3ds Max 6 and higher, calling editEffect()without an argument will open the Effects tab in the Environemnt and Effects dialog.

setEffect

Sets the render effect at the indexed position in the Rendering/Effects dialog list to the specified render effect. If the Render Effects dialog is displayed when this method is called, the displayed Render Effects list is not updated.

deleteEffect

Deletes the indexed render effect from the Rendering/Effects dialog list. The index is 1-based.

Notes

Unlike most MAXWrapper objects, you can not copy a RenderEffect.

See also

MAXWrapper Common Properties, Operators, and Methods

Value Common Properties, Operators, and Methods