Setuav Studio Developer Documentation 1.0
SDK and plugin development reference for Setuav Studio
Loading...
Searching...
No Matches
setuav_studio_sdk.models.ProjectDocument Class Reference

Project data exposed to plugins by :class:StudioAPI. More...

Inherits Protocol.

Collaboration diagram for setuav_studio_sdk.models.ProjectDocument:

Public Member Functions

Path location (self)
 Filesystem location represented by the document.
 
bool degraded (self)
 Whether loading the document reported plugin issues.
 
Any vehicle (self)
 Domain Vehicle model representation.
 
Any get_plugin_data (self, str namespace, Any default=None)
 Retrieve root-level plugin data.
 
None set_plugin_data (self, str namespace, Any value)
 Set root-level plugin data.
 
None remove_plugin_data (self, str namespace)
 Remove root-level plugin data.
 
dict[str, Any]|None get_component (self, str comp_id)
 Find a component by ID.
 
Any get_typed_component (self, str comp_id)
 Find a component by ID and return typed domain component.
 
Any get_component_plugin_data (self, str comp_id, str namespace, Any default=None)
 Retrieve component-level plugin data.
 
None set_component_plugin_data (self, str comp_id, str namespace, Any value)
 Set component-level plugin data.
 

Detailed Description

Project data exposed to plugins by :class:StudioAPI.

The application supplies the concrete document implementation. Plugins only depend on this structural contract and can therefore use the SDK without importing the application package.