Scene Controller

activate_scene(name)

Parameters:

Name	Type	Description	Default
name	str	name	required

Returns:

Type	Description
bool	result

Source code in scene_controller/__init__.py

def activate_scene(name: str) -> bool:
    """

    Args:
        name (str): name

    Returns:
        bool: result
    """

add_elements_to_scene(name, elements)

Parameters:

Name	Type	Description	Default
name	str	name	required
elements	List[int]	element IDs	required

Returns:

Type	Description
bool	result

Source code in scene_controller/__init__.py

def add_elements_to_scene(name: str, elements: List[int]) -> bool:
    """

    Args:
        name (str): name
        elements (List[int]): element IDs

    Returns:
        bool: result
    """

add_scene(name)

Parameters:

Name	Type	Description	Default
name	str	scene name	required

Returns:

Type	Description
bool	result

Source code in scene_controller/__init__.py

def add_scene(name: str) -> bool:
    """

    Args:
        name (str): scene name

    Returns:
        bool: result
    """

delete_scene(name)

Parameters:

Name	Type	Description	Default
name	str	name	required

Returns:

Type	Description
bool	result

Source code in scene_controller/__init__.py

def delete_scene(name: str) -> bool:
    """

    Args:
        name (str): name

    Returns:
        bool: result
    """

get_elements_from_scene(name)

Parameters:

Name	Type	Description	Default
name	str	name	required

Returns:

Type	Description
List[int]	element IDs

Source code in scene_controller/__init__.py

def get_elements_from_scene(name: str) -> List[int]:
    """

    Args:
        name (str): name

    Returns:
        List[int]: element IDs
    """

get_scene_list()

get list of scenes in use

Returns:

Type	Description
List[str]	scenes

Source code in scene_controller/__init__.py

def get_scene_list() -> List[str]:
    """get list of scenes in use

    Returns:
        List[str]: scenes
    """

remove_elements_from_scene(name, elements)

Parameters:

Name	Type	Description	Default
name	str	name	required
elements	List[int]	element IDs	required

Returns:

Type	Description
bool	result

Source code in scene_controller/__init__.py

def remove_elements_from_scene(name: str, elements: List[int]) -> bool:
    """

    Args:
        name (str): name
        elements (List[int]): element IDs

    Returns:
        bool: result
    """

rename_scene(old_name, new_name)

Parameters:

Name	Type	Description	Default
old_name	str	old scene name	required
new_name	str	new scene name	required

Returns:

Type	Description
bool	result

Source code in scene_controller/__init__.py

def rename_scene(old_name: str, new_name: str) -> bool:
    """

    Args:
        old_name (str): old scene name
        new_name (str): new scene name

    Returns:
        bool: result
    """