Vizard 8 » Command Index » Vizard objects » node3d » <node3d>.setMask
8.1

<node3d>.setMask

Set the node mask

<node3d>.setMask(  
mask  
node = ''  
mode = viz.MASK_SET  
op = viz.OP_DEFAULT  
)  
mask
The node mask
node = ''
Name of subnode to set the node mask of
mode = viz.MASK_SET
Mode for specifying how to apply the mask. Can be one of the following:

Mask modes

viz.MASK_SET

Set the mask to the new value.

viz.MASK_ADD

Add the value to the existing mask.

viz.MASK_REMOVE

Remove the value from the existing mask.

viz.MASK_TOGGLE

Toggle the value with the existing mask.

op = viz.OP_DEFAULT
Can be viz.OP_DEFAULT to use the nodes default op mode or a combination of the following values:

Op modes

viz.OP_TRAVERSE

When performing an operation on a node, traverse the entire subgraph and process all subnodes as well. This is the default value.

viz.OP_OVERRIDE

When applying attributes, have them override attributes of subnodes.

viz.OP_ROOT

When performing an operation on the node, start at the root transform of the node, instead of the model. Processing the root will include all child Vizard nodes.

Remarks

This command will set the node mask. The node mask controls whether the node will take part in certain operations (i.e. picking, intersection tests, rendering)

By default, all the bits in the node mask are set.

Return Value

None