API#

  • 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.properties_pane.properties.usd.widget.PropertyWidget(
context_name: str,
lookup_table: Dict[str, Dict[str, str]] | None = None,
specific_attributes: List[str] | None = None,
field_builders: list[FieldBuilder] | None = None,
optional_attributes: list[tuple[Callable[[Prim], bool], Dict[str, any]]] | None = None,
tree_column_widths: List[Length] | None = None,
columns_resizable: bool = False,
right_aligned_labels: bool = True,
)#

Bases: object

__init__(
context_name: str,
lookup_table: Dict[str, Dict[str, str]] | None = None,
specific_attributes: List[str] | None = None,
field_builders: list[FieldBuilder] | None = None,
optional_attributes: list[tuple[Callable[[Prim], bool], Dict[str, any]]] | None = None,
tree_column_widths: List[Length] | None = None,
columns_resizable: bool = False,
right_aligned_labels: bool = True,
)#

Property tree that show USD attributes

Parameters:

  • context_name – the usd context name

  • lookup_table – table that will contain the display name of the attribute and the group. Example: {“inputs:diffuse_color_constant”: {“name”: “Base Color”, “group”: “Albedo”}}

  • specific_attributes – list of exclusive attributes that we want to show

  • field_builders (List[_FieldBuilder])

  • optional_attributes – extra attributes that can be created on light prims. List of (test_func, dictionary) Tuples. Test_func takes a prim and returns a bool, Dictionaries should contain name, token, type, and default value.

  • tree_column_widths – the width of the columns

  • columns_resizable – if the columns are resizable

  • right_aligned_labels – if the labels are right aligned

destroy()#
property field_builders#
property property_model#
refresh(
paths: List[str | Path] | None = None,
)#

Refresh the panel with the given prim paths

Parameters:

paths – the USD prim paths to use

set_lookup_table(
lookup_table: Dict[str, Dict[str, str]],
)#
set_specific_attributes(
specific_attributes: List[str],
)#
show(value)#

Show the panel or not

Parameters:

value – visible or not

subscribe_refresh_done(callback)#

Return the object that will automatically unsubscribe when destroyed.

property visible#