lightspeed.trex.asset_modifiers.core#

  • SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

  • SPDX-License-Identifier: Apache-2.0

  • Licensed under the Apache License, Version 2.0 (the “License”);

  • you may not use this file except in compliance with the License.

  • You may obtain a copy of the License at

  • https://www.apache.org/licenses/LICENSE-2.0

  • Unless required by applicable law or agreed to in writing, software

  • distributed under the License is distributed on an “AS IS” BASIS,

  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  • See the License for the specific language governing permissions and

  • limitations under the License.

class lightspeed.trex.asset_modifiers.core.AssetModifiersCore(context_name: str)#

Resolve the active modifier for one USD context and prepare its Job Queue graphs.

property active_modifier: type[AssetModifierBase] | None#

Return the stored modifier, or the first registered modifier by display name.

get_run_block_reason() → str | None#

Return why Run Modifier cannot start.

get_selection_block_reason(
prim: Prim,
) → str | None#

Return why a Stage Manager row cannot run the active modifier.

async prepare_submission(
prim_paths: list[str] | None = None,
progress: Callable[[int, int], None] | None = None,
is_cancelled: Callable[[], bool] | None = None,
) → tuple[list[JobGraph], dict[str, str]]#

Build one graph per source model of the active modifier.

Parameters:

  • prim_paths – Prims to modify when the source is Selected. None uses the current selection. All and File Path Constant sources ignore it.

  • progress – Called with the current and total prim count while the prims are read.

  • is_cancelled – Polled while the prims are read. A cancelled preparation returns no graphs and no skips.

Returns:

The graphs to submit, and the reason for each skipped prim path, or model path for a skipped constant file.

Raises:

RuntimeError – If the modifier cannot run. The message is the reason from get_run_block_reason().