omni.flux.validator.mass.queue.widget#

  • SPDX-FileCopyrightText: Copyright (c) 2024 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.

  • SPDX-FileCopyrightText: Copyright (c) 2024 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 omni.flux.validator.mass.queue.widget.tree.delegate.Delegate(
use_global_style: bool = False,
style: Dict[str, Any] | None = None,
)#

Delegate of the tree

build_branch(model, item, column_id, level, expanded)#

Create a branch widget that opens or closes subtree

build_header(column_id)#

Build the header

build_widget(model, item: _Item, column_id, level, expanded)#

Create a widget per item

  • SPDX-FileCopyrightText: Copyright (c) 2024 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 omni.flux.validator.mass.queue.widget.tree.model.Actions(value)#

An enumeration.

class omni.flux.validator.mass.queue.widget.tree.model.Item(data: _ManagerCore)#

Item of the model

build_actions_ui()#

Ui that will expose controllers

can_item_have_children(
item: Item,
) → bool#

Define if the item can have children or not

Parameters:

item – the item itself

Returns:

If the item can has a children or not

mass_build_queue_action_ui(
default_actions: List[Callable[[], Any]],
callback: Callable[[str], Any],
) → Any#

Default exposed action for Mass validation. The UI will be built into the delegate of the mass queue.

on_mass_queue_action_pressed(action_name: str, **kwargs)#

Called when the user click with the left mouse button

on_mouse_hovered(hovered)#

Called when the user click with the left mouse button

subscribe_mass_queue_action_pressed(
callback: Callable[[Item, str, Any | None], Any],
)#

Return the object that will automatically unsubscribe when destroyed.

class omni.flux.validator.mass.queue.widget.tree.model.Model#

Basic list model

add_items(
items: List[Item],
)#

Set the items to show

add_schema_in_update_item_queue(schema: _ValidationSchema)#

Add a schema into a queue. Use the dictionary to track what was the last schema added in the queue.

Parameters:

schema – the updated schema to use for the update

get_item_children(
item: Item | None,
)#

Returns all the children when the widget asks it.

get_item_value_model(item, column_id)#

Return value model. It’s the object that tracks the specific value. In our case we use ui.SimpleStringModel.

get_item_value_model_count(
item: Item,
)#

The number of columns

pause_update_item_queue(value: bool)#

Pause the update of the item(s).

remove_items(
items: List[Item],
)#

Set the items to show

subscribe_progress(
callback: Callable[[float, bool], Any],
)#

Return the object that will automatically unsubscribe when destroyed.

update_item()#

Update an item from a given schema that has the same UUID.