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 lightspeed.trex.project_wizard.setup_page.widget.SetupPage(context_name: str = '', previous_page: Optional[omni.flux.wizard.widget.items.WizardPage] = None, next_page: Optional[omni.flux.wizard.widget.items.WizardPage] = None)

Bases: omni.flux.wizard.widget.items.WizardPage

LABEL_WIDTH = 140
TREE_HEIGHT = 100
__init__(context_name: str = '', previous_page: Optional[omni.flux.wizard.widget.items.WizardPage] = None, next_page: Optional[omni.flux.wizard.widget.items.WizardPage] = None)

The items used by the WizardModel. An item is a page and is rendered inside the wizard. The create_ui method should be implemented to determine what the page will look like.

Parameters

  • previous_page – A reference to the page to render when going to the previous page. If None, the “Previous” button will be disabled.

  • next_page – A reference to the page to render when going to the next page. If None, the “Next” button will become the “Done” button.

  • next_text – Text to use for the “Next” button

  • previous_text – Text to use for the “Previous” button

  • done_text – Text to use for the “Done” button

  • blocked – Whether the widget navigation should be blocked or not

  • hide_navigation – Whether the widget navigation bar should be visible or not

create_ui()

The UI displayed in the Wizard should be defined in this method.

property open_or_create: bool

Whether the setup is to open an existing project or create a new project

subscribe_file_picker_closed(function: Callable[[], None])

Return the object that will automatically unsubscribe when destroyed. Called when the file picker is closed.

subscribe_file_picker_opened(function: Callable[[], None])

Return the object that will automatically unsubscribe when destroyed. Called when the file picker is opened.