Inheritance diagram for SceneObject:
Collaboration diagram for SceneObject:
Public Member Functions | |
| def | __init__ (self, name, plugin=None, kwargs) |
| def | __getattr__ (self, name) |
| def | getLabel (self) |
| def | getPropTuples (self) |
| def | getName (self) |
| def | setName (self, name) |
| def | getReprTypes (self) |
| def | removeRepr (self, rep) |
| def | getDataset (self) |
| def | setTimestepList (self, tslist) |
| def | setTimestepScheme (self, starttime, interval) |
| def | getTimestepList (self) |
| def | getTimestepScheme (self) |
| def | __repr__ (self) |
Public Attributes | |
| name | |
| reprs | |
| reprcount | |
| plugin | |
| kwargs | |
| reprtypes | |
| proptuples | |
Detailed Description
A SceneObject represents the data of a single notional object, for example the data for a model or all of the imaging slices for an image set. These are loaded from data sources by plugins or can be instantiated within scripts. In either case they must be added to the scene with SceneManager.addSceneObject() before they can be used for creating a representation. Once they have been added, they can produce instances of SceneObjectRepr to visually represent the data store. The representations are stored as children of the originating SceneObject.
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
| name, | |||
plugin = None, |
|||
| kwargs | |||
| ) |
Member Function Documentation
◆ __getattr__()
| def __getattr__ | ( | self, | |
| name | |||
| ) |
◆ __repr__()
| def __repr__ | ( | self | ) |
Here is the call graph for this function:
◆ getDataset()
| def getDataset | ( | self | ) |
Returns the underlying data structures defining this object.
◆ getLabel()
| def getLabel | ( | self | ) |
Returns the UI label.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getName()
| def getName | ( | self | ) |
Returns the name of the object.
Here is the caller graph for this function:
◆ getPropTuples()
| def getPropTuples | ( | self | ) |
Returns a list of name/value pairs listing the properties to display for this scene object in the UI. This can use self.proptuples as a cache for efficiency, so the method fills in self.proptuples if this attribute is empty and returns it thereafter.
◆ getReprTypes()
| def getReprTypes | ( | self | ) |
Returns an iterable of ReprType names identifying valid representations of this object.
Here is the caller graph for this function:
◆ getTimestepList()
| def getTimestepList | ( | self | ) |
Returns the timestep values for each timestep of the object, or just [0] if it's not time-dependent.
Here is the caller graph for this function:
◆ getTimestepScheme()
| def getTimestepScheme | ( | self | ) |
Here is the call graph for this function:
◆ removeRepr()
| def removeRepr | ( | self, | |
| rep | |||
| ) |
◆ setName()
| def setName | ( | self, | |
| name | |||
| ) |
Sets the name of the object.
◆ setTimestepList()
| def setTimestepList | ( | self, | |
| tslist | |||
| ) |
Sets the timesteps for this object. The arguments `tslist' must have ascending values, one for each frame of data.
◆ setTimestepScheme()
| def setTimestepScheme | ( | self, | |
| starttime, | |||
| interval | |||
| ) |
Set timestepping such that the first timestep is `starttime' and each subsequent step is `interval' forward in time.
Member Data Documentation
◆ kwargs
| kwargs |
◆ name
| name |
◆ plugin
| plugin |
◆ proptuples
| proptuples |
◆ reprcount
| reprcount |
◆ reprs
| reprs |
◆ reprtypes
| reprtypes |
The documentation for this class was generated from the following file:
- eidolon/SceneObject.py
