Object

class compas_ui.objects.Object(*args, **kwargs)[source]

Bases: object

Base class for all objects.

Parameters:

  • item (compas.data.Data) – A COMPAS data object.

  • scene (compas.scenes.Scene, optional) – A scene object.

  • name (str, optional) – The name of the object.

  • visible (bool, optional) – Toggle for the visibility of the object.

  • settings (dict[str, Any], optional) – A dictionary of settings.

Attributes:

  • item (compas.data.Data) – The COMPAS data object assignd to this scene object.

  • scene (compas.scenes.Scene) – The scene.

  • artist (compas.artists.Artist) – The artist matching the type of item.

  • name (str) – The name of the object. This is an alias for the name of item.

  • visible (bool) – Toggle for the visibility of the object in the scene.

  • settings (dict) – A dictionary of settings related to visualisation and interaction. This dict starts from the settings of the artist.

Methods

add

clear

draw

modify

move

redraw

register

remove

select