system_base
BaseSystem
Bases: SerializableNonInstance
, UniquelyNamedNonInstance
Base class for all systems. These are non-instance objects that should be used globally for a given environment. This is useful for items in a scene that are non-discrete / cannot be distinguished into individual instances, e.g.: water, particles, etc.
Source code in systems/system_base.py
cache()
classmethod
clear()
classmethod
Clears this system, so that it may possibly be re-initialized. Useful for, e.g., when loading from a new scene during the same sim instance
initialize(simulator)
classmethod
Initializes this system. Default behavior is to simply store the @simulator reference internally
Source code in systems/system_base.py
initialized()
Returns:
Name | Type | Description |
---|---|---|
bool | True if this system has been initialized via cls.initialize(...), else False |
reset()
classmethod
get_element_name_from_system(system)
Grabs system element name representing the element being controlled by system @system
Parameters:
Name | Type | Description | Default |
---|---|---|---|
system |
BaseSystem
|
system from which to grab element name |
required |
Returns:
Name | Type | Description |
---|---|---|
BaseSystem | Corresponding system singleton |
Source code in systems/system_base.py
get_system_from_element_name(name)
Grabs system based on its element name @name that it controls (e.g.: Water, Dust, Stain, etc....)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
element name corresponding to the desired system to grab |
required |
Returns:
Name | Type | Description |
---|---|---|
BaseSystem | Corresponding system singleton |