Locking Scene Elements

 
 
 

You can lock an entire scene or elements within a scene from an explorer. You can apply a lock at a specific level or lock all levels at the same time.

To lock scene elements by level

  1. Open an explorer and set its scope to Scene Root.

  2. Select the scene element node that you want to lock.

  3. Right-click the selection to open its context menu.

  4. Choose Locks and activate the specific lock level option:

    • Node Topology/Hierarchy Locked

    • Animation Locked

    • Value Locked

    • Lock All Levels

    When a scene element is protected, the word (LOCK) is displayed beside its name in the explorer. When LOCK is in capital letters, it means that this is the lock owner.

    All its child nodes inherit the lock and display the (lock) label as well, but in lowercase letters to denote their inheritance.

    NoteIf you try to modify an object that is locked, the history pane in the script editor displays the error message ERROR : 2087 - The object: <object> is locked, and no action is taken.

To apply additional lock levels to scene elements

You can progressively add lock levels to scene elements that are already locked.

  1. In an explorer, select the lock owner (the node on which you originally applied the lock).

  2. Right-click the selection to open its context menu.

  3. Choose Locks and activate another lock level. You will notice that a check mark appears next to the applied lock levels in the menu.

Locking Parameters

You can lock parameters the same way you would lock any other scene element, but what makes locking parameters different is that they are the only element that you can also lock in node mode (all other locks are applied in branch mode).

A parameter can inherit a lock from the hierarchy above it, but you can always go back and apply another lock level or lock all levels for only that parameter: the parameter can be said to have a local lock.

When a parameter is locked, a lock icon appears beside it in both the explorer and its property editor:

  • Black lock icons denote that the parameter is the lock owner.

  • Gray lock icons denote an inherited lock.

  • Red lock icons denote parameters in reference models or parameters with overrides. You cannot modify these parameters because they're system-locked.

    A

    Lock icon for parameters in the explorer and property editor.

    B

    Parameters of referenced models have red lock icons.

Proxy Parameters

If you lock a parameter that is then proxied in a custom parameter set, the proxy parameter is also locked. And when you lock a proxy parameter, the original parameter from which it was proxied is also locked.

If you lock a custom parameter set that contains proxy parameters, the proxy parameters inherit the lock, but the original parameters are not locked.

Example: Locking All for a Single Parameter

  1. From the Model toolbar, choose Get Primitive Polygon Mesh Sphere.

  2. In an explorer, select the Sphere object node. Set the explorer scope to Scene Root and the filter to All Nodes or All + Animatable Params (as needed) to display parameters.

  3. Right-click the Sphere node and choose Locks Node Topology/Hierarchy Locked.

    The word (LOCK) is displayed beside the node. All its child nodes inherit the lock and display the (lock) label as well, but in lowercase letters.

    All its parameters have a gray lock icon beside them (in the explorer and property editor).

  4. Expand the Sphere down to the Kinematics Local Transform Pos X parameter.

  5. Right-click the parameter and choose Locks Value Locked.

    The lock icon beside the parameter turns black to indicate that it's locked at the parameter level.

    The Sphere is locked at the Node Topology/Hierarchy level, except for this single parameter, which is essentially locked at all levels because the Value lock includes the Animation lock level above it.

Tip
  • You can also lock a parameter by right-clicking its animation icon in the explorer or a property page and choosing Locks Animation Locked or Value Locked.

  • If the master parameter of a proxy parameter is locked, the proxy parameter is also locked and displays a (lock) label beside its name.

Lock Level Results Table

This table gives the results of locking specific scene elements at different levels.

Element

Topology/hierarchy lock

Animation lock

Value lock

Parameters

n/a

Cannot set keyframes, expressions, or scripted operators.

Cannot modify the shape of fcurves or the content of expressions.

Cannot set or modify parameter values.

Parameter sets

Cannot add or remove parameters from a custom parameter set.

Equivalent to having all parameters locked at the animation level.

Equivalent to having all parameters locked at the value level.

Operators

Cannot delete locked topology operators.

n/a

Cannot delete locked deformation operators.

Geometry, primitives

Cannot apply topology operators (unable to modify the topology of the geometry).

Same as a value lock.

Cannot apply deformations including Move Component and Envelope operators (unable to modify the shape of the geometry).

3D objects and models

Cannot parent or cut objects from the hierarchy.

Cannot add parameter sets or apply operators.

Cannot set keyframes, or apply expressions or scripted operators on parameters of the object node.

Cannot modify parameters or manipulate objects (SRT).

Groups (and layers and partitions) and clusters

Cannot add or remove members or components.

Cannot apply a property.

Cannot set keyframes, or apply expressions or scripted operators on parameters for the group or group members.

Cannot change values of any property for the group or group member.