Home / Webapp / Scene
Webapp

Scene

3D scene widget for point clouds and models.

66 config keys · 57 public methods

Import

from Xenonix.Webapp import Scene

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

Config key Default Common values What it controls
Name False Any valid value Object name used for lookup, labels, or public access.
Background '#111827' Any valid value Background color.
Foreground '#e5e7eb' Any valid value Text/foreground color.
Border_Color '#1e293b' Any valid value Border color.
Border_Size 0 Any valid value Border thickness.
Border_Radius 0 Any valid value Corner radius.
Display True True, False Initial visible/hidden state.
Left None Any valid value Left position when placed absolutely.
Top None Any valid value Top position when placed absolutely.
Right None Any valid value Right position when placed absolutely.
Bottom None Any valid value Bottom position when placed absolutely.
Width 600 Any valid value Widget or image width.
Height 400 Any valid value Widget or image height.
Canvas_Width 1200 Any valid value Canvas Width setting for Scene.
Canvas_Height 800 Any valid value Canvas Height setting for Scene.
Padding 0 Any valid value Inner spacing.
Margin 0 Any valid value Extra region margin.
Mode 'Flow' Flow, Place, Auto, Manual Layout or algorithm mode.
Classes '' Any valid value Extra CSS classes.
Style '' Any valid value Extra CSS style.
Z_Index None Any valid value CSS stacking order.
Shadow_X 0 Any valid value Horizontal shadow offset.
Shadow_Y 0 Any valid value Vertical shadow offset.
Shadow_Blur 0 Any valid value Shadow blur amount.
Shadow_Spread 0 Any valid value Shadow spread amount.
Shadow_Color 'transparent' Any valid value Shadow color.
Grid False True, False Shows or hides a grid where supported.
Point_Size 0.08 Any valid value Point display size.
Point_Color '#38bdf8' Any valid value Default point color.
Model_Color '#e5e7eb' Any valid value Default model color.
Model_Scale 1.0 Any valid value Default model scale.
Model_Wireframe False Any valid value Shows model as wireframe where supported.
Model_Edges True Any valid value Shows model edges where supported.
Model_Edge_Color '#38bdf8' Any valid value Model Edge Color setting for Scene.
Model_Edge_Opacity 1.0 Any valid value Model Edge Opacity setting for Scene.
Model_Edge_Limit 4000 Any valid value Model Edge Limit setting for Scene.
Model_Edge_Precision 5 Any valid value Model Edge Precision setting for Scene.
Model_Face_Limit 200000 Any valid value Model Face Limit setting for Scene.
Multi_Select True True, False Allows multiple selections.
Plane_Edge_Color '#f97316' Any valid value Plane Edge Color setting for Scene.
Plane_Normal_Color '#22c55e' Any valid value Plane Normal Color setting for Scene.
Plane_Normal_Length 2.0 Any valid value Plane Normal Length setting for Scene.
Model_Opacity 1.0 Any valid value Model Opacity setting for Scene.
Model_Side 'double' front, back, double Model Side setting for Scene.
Selected_Color '#f97316' Any valid value Color used for selected items.
Selected_Size 0.18 Any valid value Selected Size setting for Scene.
Selected_Auto_Size True Any valid value Selected Auto Size setting for Scene.
Selected_Min_Size 0.025 Any valid value Selected Min Size setting for Scene.
Selected_Max_Size 0.35 Any valid value Selected Max Size setting for Scene.
Selected_Size_Reference_Distance 8.0 Any valid value Selected Size Reference Distance setting for Scene.
Select_Face False True, False Select Face setting for Scene.
Rotate_Around_Selected True Any valid value Rotate Around Selected setting for Scene.
Click_Move_Threshold 4 Any valid value Click Move Threshold setting for Scene.
Move_Step 0.05 Any valid value Move Step setting for Scene.
Move_Fast_Step 0.25 Any valid value Move Fast Step setting for Scene.
Move_Slow_Step 0.01 Any valid value Move Slow Step setting for Scene.
Auto_Camera True True, False Automatically fits the camera to loaded content.
Camera_X 5 Any valid value Default camera X position.
Camera_Y -8 Any valid value Default camera Y position.
Camera_Z 5 Any valid value Default camera Z position.
Look_At_X 0 Any valid value Default camera target X position.
Look_At_Y 0 Any valid value Default camera target Y position.
Look_At_Z 0 Any valid value Default camera target Z position.
Up_X 0 Any valid value Camera up-vector X component.
Up_Y 0 Any valid value Camera up-vector Y component.
Up_Z 1 Any valid value Camera up-vector Z component.

Public methods

Create

Creates a new Scene instance.

Create(Main, *args, **kwargs)

Arguments

Argument Default Accepted values What it does
Main Required Any valid value Main value used by the operation.
args *args Any valid value Additional values passed to the operation.
kwargs **kwargs Any valid value Additional values passed to the operation.

Output

Creates a new Scene object.

Create

Runs the Create operation for Scene.

Create()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Refresh

Runs the Refresh operation for Scene.

Refresh(Render=False)

Arguments

Argument Default Accepted values What it does
Render False Any valid value Turns render on or off.

Output

Updates the object or visible UI state.

Delete

Removes the requested item.

Delete()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Clear

Clears stored data, selection, or visible content.

Clear()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Show

Displays the object/result.

Show()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Hide

Hides the object/result.

Hide()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Focus

Moves focus to this widget/object where supported.

Focus()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Widget

Runs the Widget operation for Scene.

Widget()

Arguments

No arguments.

Output

Returns the calculated result.

Scene_Widget

Runs the Scene_Widget operation for Scene.

Scene_Widget()

Arguments

No arguments.

Output

Returns the calculated result.

Add_Point_Cloud

Adds a new item to the object or UI.

Add_Point_Cloud(Points, Name=False, Colors=None, Point_Size=None, Color=None, Point_Data=None)

Arguments

Argument Default Accepted values What it does
Points Required Any valid value Point data, usually Nx2 or Nx3.
Name False Any valid value Display/name identifier.
Colors None Any valid value Per-point or display colors.
Point_Size None Any valid value Point cloud display size.
Color None Any valid value Color used for drawing or display.
Point_Data None Any valid value Point Data value used by the operation.

Output

Adds a new item and returns the created object/id when available.

Add_Point_Cloud_Fast

Adds a new item to the object or UI.

Add_Point_Cloud_Fast(Points, Name=False, Colors=None, Point_Size=None, Color=None, Point_Data=None)

Arguments

Argument Default Accepted values What it does
Points Required Any valid value Point data, usually Nx2 or Nx3.
Name False Any valid value Display/name identifier.
Colors None Any valid value Per-point or display colors.
Point_Size None Any valid value Point cloud display size.
Color None Any valid value Color used for drawing or display.
Point_Data None Any valid value Point Data value used by the operation.

Output

Adds a new item and returns the created object/id when available.

Add_Z_Height

Adds a new item to the object or UI.

Add_Z_Height(Image, Name=False, X_Step=1.0, Y_Step=1.0, X_Offset=0.0, Y_Offset=0.0, Colors=None, Point_Size=None, Color=None, Image_Order='XY')

Arguments

Argument Default Accepted values What it does
Image Required Any valid value Input image data or image object.
Name False Any valid value Display/name identifier.
X_Step 1.0 Any valid value X Step value used by the operation.
Y_Step 1.0 Any valid value Y Step value used by the operation.
X_Offset 0.0 Any valid value X Offset value used by the operation.
Y_Offset 0.0 Any valid value Y Offset value used by the operation.
Colors None Any valid value Per-point or display colors.
Point_Size None Any valid value Point cloud display size.
Color None Any valid value Color used for drawing or display.
Image_Order 'XY' Any valid value Image Order value used by the operation.

Output

Adds a new item and returns the created object/id when available.

Add_STL

Adds a new item to the object or UI.

Add_STL(Source, Name=False, Wireframe=None, Edges=None, Edge_Color=None, Edge_Opacity=None, Edge_Limit=None, Color=None, Opacity=None, Side=None, X=0.0, Y=0.0, Z=0.0, RX=0.0, RY=0.0, RZ=0.0, Scale=None)

Arguments

Argument Default Accepted values What it does
Source Required Any valid value Source value used by the operation.
Name False Any valid value Display/name identifier.
Wireframe None Any valid value Wireframe value used by the operation.
Edges None Any valid value Edges value used by the operation.
Edge_Color None Any valid value Edge Color value used by the operation.
Edge_Opacity None Any valid value Edge Opacity value used by the operation.
Edge_Limit None Any valid value Edge Limit value used by the operation.
Color None Any valid value Color used for drawing or display.
Opacity None Any valid value Opacity value used by the operation.
Side None Any valid value Side value used by the operation.
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Z 0.0 Any valid value Z coordinate, depth, or height value.
RX 0.0 Any valid value RX value used by the operation.
RY 0.0 Any valid value RY value used by the operation.
RZ 0.0 Any valid value RZ value used by the operation.
Scale None Any valid value Scale value used by the operation.

Output

Adds a new item and returns the created object/id when available.

Add_OBJ

Adds a new item to the object or UI.

Add_OBJ(Source, Name=False, Edges=True, Edge_Color=None, Edge_Opacity=None, Edge_Limit=None, X=0.0, Y=0.0, Z=0.0, RX=0.0, RY=0.0, RZ=0.0, Scale=None)

Arguments

Argument Default Accepted values What it does
Source Required Any valid value Source value used by the operation.
Name False Any valid value Display/name identifier.
Edges True Any valid value Turns edges on or off.
Edge_Color None Any valid value Edge Color value used by the operation.
Edge_Opacity None Any valid value Edge Opacity value used by the operation.
Edge_Limit None Any valid value Edge Limit value used by the operation.
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Z 0.0 Any valid value Z coordinate, depth, or height value.
RX 0.0 Any valid value RX value used by the operation.
RY 0.0 Any valid value RY value used by the operation.
RZ 0.0 Any valid value RZ value used by the operation.
Scale None Any valid value Scale value used by the operation.

Output

Adds a new item and returns the created object/id when available.

Add_GLTF

Adds a new item to the object or UI.

Add_GLTF(Source, Name=False, Color=None, Opacity=None, Side=None, X=0.0, Y=0.0, Z=0.0, RX=0.0, RY=0.0, RZ=0.0, Scale=None)

Arguments

Argument Default Accepted values What it does
Source Required Any valid value Source value used by the operation.
Name False Any valid value Display/name identifier.
Color None Any valid value Color used for drawing or display.
Opacity None Any valid value Opacity value used by the operation.
Side None Any valid value Side value used by the operation.
X 0.0 Any valid value X coordinate or horizontal value.
Y 0.0 Any valid value Y coordinate or vertical value.
Z 0.0 Any valid value Z coordinate, depth, or height value.
RX 0.0 Any valid value RX value used by the operation.
RY 0.0 Any valid value RY value used by the operation.
RZ 0.0 Any valid value RZ value used by the operation.
Scale None Any valid value Scale value used by the operation.

Output

Adds a new item and returns the created object/id when available.

Delete_Object

Removes the requested item.

Delete_Object(Object_Id)

Arguments

Argument Default Accepted values What it does
Object_Id Required Object_Id Mode/value selector for object id.

Output

Returns True/False to indicate success.

Object_Visible

Runs the Object_Visible operation for Scene.

Object_Visible(Object_Id, Value=None)

Arguments

Argument Default Accepted values What it does
Object_Id Required Any valid value Object Id value used by the operation.
Value None Any valid value Value to set or process.

Output

Returns True/False to indicate success.

Show_Object

Runs the Show_Object operation for Scene.

Show_Object(Object_Id)

Arguments

Argument Default Accepted values What it does
Object_Id Required Any valid value Object Id value used by the operation.

Output

Returns True/False to indicate success.

Hide_Object

Runs the Hide_Object operation for Scene.

Hide_Object(Object_Id)

Arguments

Argument Default Accepted values What it does
Object_Id Required Any valid value Object Id value used by the operation.

Output

Returns True/False to indicate success.

Toggle_Object

Runs the Toggle_Object operation for Scene.

Toggle_Object(Object_Id)

Arguments

Argument Default Accepted values What it does
Object_Id Required Any valid value Object Id value used by the operation.

Output

Returns True/False to indicate success.

Set_Point_Cloud

Sets a specific value.

Set_Point_Cloud(Object_Id, Points, Colors=None, Point_Data=None)

Arguments

Argument Default Accepted values What it does
Object_Id Required Type, Point_Cloud, Fast_Point_Cloud Mode/value selector for object id.
Points Required Any valid value Point data, usually Nx2 or Nx3.
Colors None Any valid value Per-point or display colors.
Point_Data None Any valid value Point Data value used by the operation.

Output

Sets the value and returns the updated object or status.

Set_Z_Height

Sets a specific value.

Set_Z_Height(Object_Id, Image, X_Step=None, Y_Step=None, X_Offset=None, Y_Offset=None, Colors=None, Image_Order=None)

Arguments

Argument Default Accepted values What it does
Object_Id Required Z_Height, Type Mode/value selector for object id.
Image Required Any valid value Input image data or image object.
X_Step None Any valid value X Step value used by the operation.
Y_Step None Any valid value Y Step value used by the operation.
X_Offset None Any valid value X Offset value used by the operation.
Y_Offset None Any valid value Y Offset value used by the operation.
Colors None Any valid value Per-point or display colors.
Image_Order None Any valid value Image Order value used by the operation.

Output

Sets the value and returns the updated object or status.

Point_Cloud

Runs the Point_Cloud operation for Scene.

Point_Cloud(Object_Id=False, Numpy=True, DType='float32')

Arguments

Argument Default Accepted values What it does
Object_Id False Any valid value Turns object id on or off.
Numpy True Any valid value When True, returns NumPy arrays instead of Python lists where supported.
DType 'float32' Any valid value DType value used by the operation.

Output

Returns structured data such as a list or dictionary.

Get_Point_Cloud

Returns a specific value.

Get_Point_Cloud(Object_Id=False, Numpy=True, DType='float32')

Arguments

Argument Default Accepted values What it does
Object_Id False Any valid value Turns object id on or off.
Numpy True Any valid value When True, returns NumPy arrays instead of Python lists where supported.
DType 'float32' Any valid value DType value used by the operation.

Output

Returns the requested value.

Z_Height

Runs the Z_Height operation for Scene.

Z_Height(Object_Id=False, Width=320, Height=240, Camera=None, Numpy=True, Empty_Value=None, Image_Order='XY', DType='float32')

Arguments

Argument Default Accepted values What it does
Object_Id False Any valid value Turns object id on or off.
Width 320 Any valid value Width in pixels, world units, or widget units depending on the class.
Height 240 Any valid value Height in pixels, world units, or widget units depending on the class.
Camera None Any valid value Camera pose/settings dictionary.
Numpy True Any valid value When True, returns NumPy arrays instead of Python lists where supported.
Empty_Value None Any valid value Empty Value value used by the operation.
Image_Order 'XY' Any valid value Image Order value used by the operation.
DType 'float32' Any valid value DType value used by the operation.

Output

Returns structured data such as a list or dictionary.

Get_Z_Height

Returns a specific value.

Get_Z_Height(Object_Id=False, Width=320, Height=240, Camera=None, Numpy=True, Empty_Value=None, Image_Order='XY', DType='float32')

Arguments

Argument Default Accepted values What it does
Object_Id False Any valid value Turns object id on or off.
Width 320 Any valid value Width in pixels, world units, or widget units depending on the class.
Height 240 Any valid value Height in pixels, world units, or widget units depending on the class.
Camera None Any valid value Camera pose/settings dictionary.
Numpy True Any valid value When True, returns NumPy arrays instead of Python lists where supported.
Empty_Value None Any valid value Empty Value value used by the operation.
Image_Order 'XY' Any valid value Image Order value used by the operation.
DType 'float32' Any valid value DType value used by the operation.

Output

Returns the requested value.

Get_Z_Height_Image

Returns a specific value.

Get_Z_Height_Image(Object_Id=False, Width=320, Height=240, Camera=None, Numpy=True, Empty_Value=None, Image_Order='XY', DType='float32')

Arguments

Argument Default Accepted values What it does
Object_Id False Any valid value Turns object id on or off.
Width 320 Any valid value Width in pixels, world units, or widget units depending on the class.
Height 240 Any valid value Height in pixels, world units, or widget units depending on the class.
Camera None Any valid value Camera pose/settings dictionary.
Numpy True Any valid value When True, returns NumPy arrays instead of Python lists where supported.
Empty_Value None Any valid value Empty Value value used by the operation.
Image_Order 'XY' Any valid value Image Order value used by the operation.
DType 'float32' Any valid value DType value used by the operation.

Output

Returns the requested value.

Objects

Runs the Objects operation for Scene.

Objects()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Deselect

Runs the Deselect operation for Scene.

Deselect()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Clear_Selected_Points

Clears stored data, selection, or visible content.

Clear_Selected_Points()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Move_Selected_Points

Moves the object/data by the requested amount.

Move_Selected_Points(DX=0.0, DY=0.0, DZ=0.0)

Arguments

Argument Default Accepted values What it does
DX 0.0 Any valid value DX value used by the operation.
DY 0.0 Any valid value DY value used by the operation.
DZ 0.0 Any valid value DZ value used by the operation.

Output

Returns True/False to indicate success.

Selected_Point

Runs the Selected_Point operation for Scene.

Selected_Point()

Arguments

No arguments.

Output

Returns the calculated result.

Selected_Face

Runs the Selected_Face operation for Scene.

Selected_Face()

Arguments

No arguments.

Output

Returns the calculated result.

Selected_Points

Runs the Selected_Points operation for Scene.

Selected_Points()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Selected_Plane

Runs the Selected_Plane operation for Scene.

Selected_Plane()

Arguments

No arguments.

Output

Returns the calculated result.

Make_Selected_Plane

Runs the Make_Selected_Plane operation for Scene.

Make_Selected_Plane()

Arguments

No arguments.

Output

Returns the calculated result.

Top_View_From_Selected_Plane

Runs the Top_View_From_Selected_Plane operation for Scene.

Top_View_From_Selected_Plane(Distance=None, Duration=0.5, Reverse=False)

Arguments

Argument Default Accepted values What it does
Distance None Any valid value Distance value used by the operation.
Duration 0.5 Any valid value Duration value used by the operation.
Reverse False Any valid value Turns reverse on or off.

Output

Returns the calculated result.

Plane_From_Selected_Points

Runs the Plane_From_Selected_Points operation for Scene.

Plane_From_Selected_Points()

Arguments

No arguments.

Output

Returns the calculated result.

Top_View_Selected_Plane

Runs the Top_View_Selected_Plane operation for Scene.

Top_View_Selected_Plane(Distance=None, Duration=0.5, Reverse=False)

Arguments

Argument Default Accepted values What it does
Distance None Any valid value Distance value used by the operation.
Duration 0.5 Any valid value Duration value used by the operation.
Reverse False Any valid value Turns reverse on or off.

Output

Returns the calculated result.

Align_Current_Face

Runs the Align_Current_Face operation for Scene.

Align_Current_Face(Object_Id=False, Camera=None, Distance=None, Duration=0.35, Local_Radius=None)

Arguments

Argument Default Accepted values What it does
Object_Id False Any valid value Turns object id on or off.
Camera None Any valid value Camera pose/settings dictionary.
Distance None Any valid value Distance value used by the operation.
Duration 0.35 Any valid value Duration value used by the operation.
Local_Radius None Any valid value Local Radius value used by the operation.

Output

Returns the calculated result.

Align_View_Direction

Runs the Align_View_Direction operation for Scene.

Align_View_Direction(Camera=None, Distance=None, Duration=0.35)

Arguments

Argument Default Accepted values What it does
Camera None Any valid value Camera pose/settings dictionary.
Distance None Any valid value Distance value used by the operation.
Duration 0.35 Any valid value Duration value used by the operation.

Output

Returns the calculated result.

Aligned_Face

Runs the Aligned_Face operation for Scene.

Aligned_Face()

Arguments

No arguments.

Output

Returns the calculated result.

Aligned_Face_View

Runs the Aligned_Face_View operation for Scene.

Aligned_Face_View(Direction='Top', Distance=None, Duration=0.35)

Arguments

Argument Default Accepted values What it does
Direction 'Top' Any valid value Direction value used by the operation.
Distance None Any valid value Distance value used by the operation.
Duration 0.35 Any valid value Duration value used by the operation.

Output

Returns the calculated result.

Standard_View

Runs the Standard_View operation for Scene.

Standard_View(Direction='Top', Distance=None, Duration=0.5)

Arguments

Argument Default Accepted values What it does
Direction 'Top' Any valid value Direction value used by the operation.
Distance None Any valid value Distance value used by the operation.
Duration 0.5 Any valid value Duration value used by the operation.

Output

Returns the calculated result.

Move_Camera

Moves the object/data by the requested amount.

Move_Camera(X=None, Y=None, Z=None, Look_At_X=None, Look_At_Y=None, Look_At_Z=None, Up_X=None, Up_Y=None, Up_Z=None, Duration=0.5)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.
Z None Any valid value Z coordinate, depth, or height value.
Look_At_X None Any valid value Look At X coordinate/component.
Look_At_Y None Any valid value Look At Y coordinate/component.
Look_At_Z None Any valid value Look At Z coordinate/component.
Up_X None Any valid value Up X coordinate/component.
Up_Y None Any valid value Up Y coordinate/component.
Up_Z None Any valid value Up Z coordinate/component.
Duration 0.5 Any valid value Duration value used by the operation.

Output

Returns the calculated result.

Rotate_Current_View

Rotates the object/data by the requested angle.

Rotate_Current_View(Angle=0.0, Duration=0.05)

Arguments

Argument Default Accepted values What it does
Angle 0.0 Any valid value Angle in degrees unless the method says otherwise.
Duration 0.05 Any valid value Duration value used by the operation.

Output

Returns the calculated result.

Camera

Runs the Camera operation for Scene.

Camera()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Camera_Update

Runs the Camera_Update operation for Scene.

Camera_Update(Timeout=2.0)

Arguments

Argument Default Accepted values What it does
Timeout 2.0 Any valid value Timeout value used by the operation.

Output

Returns the calculated result.

View_Z_Height_Cloud

Runs the View_Z_Height_Cloud operation for Scene.

View_Z_Height_Cloud(Width=320, Height=240, Object_Id=False, Camera=None, Point_Size=None)

Arguments

Argument Default Accepted values What it does
Width 320 Any valid value Width in pixels, world units, or widget units depending on the class.
Height 240 Any valid value Height in pixels, world units, or widget units depending on the class.
Object_Id False Any valid value Turns object id on or off.
Camera None Any valid value Camera pose/settings dictionary.
Point_Size None Any valid value Point cloud display size.

Output

Returns structured data such as a list or dictionary.

View_Z_Height

Runs the View_Z_Height operation for Scene.

View_Z_Height(Width=320, Height=240, Object_Id=False, Camera=None, Numpy=False, Empty_Value=None, Image_Order='YX', DType='float32')

Arguments

Argument Default Accepted values What it does
Width 320 Any valid value Width in pixels, world units, or widget units depending on the class.
Height 240 Any valid value Height in pixels, world units, or widget units depending on the class.
Object_Id False Any valid value Turns object id on or off.
Camera None Any valid value Camera pose/settings dictionary.
Numpy False Any valid value When True, returns NumPy arrays instead of Python lists where supported.
Empty_Value None Any valid value Empty Value value used by the operation.
Image_Order 'YX' Any valid value Image Order value used by the operation.
DType 'float32' Any valid value DType value used by the operation.

Output

Returns structured data such as a list or dictionary.

Bind

Runs the Bind operation for Scene.

Bind(**Input)

Arguments

Argument Default Accepted values What it does
Input **kwargs Any valid value Input value used by the operation.

Output

Returns the object, so the call can be chained.

Config_Get

Reads one or more configuration values by name.

Config_Get(*Input)

Arguments

Argument Default Accepted values What it does
Input *args Any valid value Input value used by the operation.

Output

Returns selected configuration values.

Config

Changes one or more supported settings. Pass only the configuration keys you want to update.

Config(**Input)

Arguments

Argument Default Accepted values What it does
Input **kwargs Any valid value Input value used by the operation.

Output

Updates configuration values on the object.

Position

Runs the Position operation for Scene.

Position(Left=None, Top=None, Right=None, Bottom=None)

Arguments

Argument Default Accepted values What it does
Left None Any valid value Left value used by the operation.
Top None Any valid value Top value used by the operation.
Right None Any valid value Right value used by the operation.
Bottom None Any valid value Bottom value used by the operation.

Output

Returns structured data such as a list or dictionary.

Size

Runs the Size operation for Scene.

Size(Width=False, Height=False)

Arguments

Argument Default Accepted values What it does
Width False Any valid value Width in pixels, world units, or widget units depending on the class.
Height False Any valid value Height in pixels, world units, or widget units depending on the class.

Output

Returns structured data such as a list or dictionary.

Place

Runs the Place operation for Scene.

Place(Left=None, Top=None, Right=None, Bottom=None, Width=None, Height=None)

Arguments

Argument Default Accepted values What it does
Left None Any valid value Left value used by the operation.
Top None Any valid value Top value used by the operation.
Right None Any valid value Right value used by the operation.
Bottom None Any valid value Bottom value used by the operation.
Width None Any valid value Width in pixels, world units, or widget units depending on the class.
Height None Any valid value Height in pixels, world units, or widget units depending on the class.

Output

Returns the object, so the call can be chained.