Vizard 7 » Command Index » Vizard objects » effect » <effect>.remove
7.7

<effect>.remove

Remove the effect object

<effect>.remove()  

Remarks

This command will remove the effect object handle. However, by default the effect will still affect any nodes and composers it was previously applied to. This behavior can be modified by using the <effect>.setRemoveFlags command. For example, the following code will cause the effect to be unapplied from all nodes and composers when it is removed:

effect.setRemoveFlags(viz.UNAPPLY_ALL)

Return Value

None

Example

effect = viz.addEffect('effect.vizfx')
model.apply(effect)
.
.
.

# Will still affect the model
effect.remove()

See also

<effect>.getRemoveFlags
<effect>.setRemoveFlags
<effect>.getEnabled
<effect>.setEnabled
<effect>.unapply
<node3d>.clearAttribute
<node3d>.clearEffectType