Chemical Data Processing Library Python API - Version 1.1.1
|
The abstract base of classes implementing the 2D visualization of data objects. More...
Public Member Functions | |
None | __init__ () |
Initializes the View2D instance. | |
None | render (Renderer2D renderer) |
Renders the visual representation of the model using the specified Vis.Renderer2D instance. More... | |
None | setFontMetrics (FontMetrics font_metrics) |
Specifies a font metrics object that will be used to measure the dimension of text labels. More... | |
None | getModelBounds (Rectangle2D bounds) |
Calculates the bounding rectangle of the visualized model. More... | |
Public Member Functions inherited from CDPL.Base.ControlParameterContainer | |
None | setParameter (LookupKey key, Any value) |
bool | removeParameter (LookupKey key) |
Removes the entry for the control-parameter specified by key. More... | |
Any | getParameter (LookupKey key, bool throw_=False, bool local=False) |
Returns the value of the control-parameter specified by key. More... | |
Any | getParameterOrDefault (LookupKey key, Any def_value, bool local=False) |
bool | isParameterSet (LookupKey key, bool local=False) |
Tells whether or not a value has been assigned to the control-parameter specified by key. More... | |
None | clearParameters () |
Erases all container entries. More... | |
None | addParameters (ControlParameterContainer cntnr) |
Adds the control-parameter value entries in the ControlParameterContainer instance cntnr. More... | |
None | copyParameters (ControlParameterContainer cntnr) |
Replaces the current set of properties by a copy of the entries in cntnr. More... | |
int | getNumParameters () |
Returns the number of container entries. More... | |
int | registerParameterChangedCallback (VoidLookupKeyAnyFunctor func) |
Registers a callback target function that gets invoked when the value of a control-parameter has changed. More... | |
None | unregisterParameterChangedCallback (int id) |
Unregisters the callback specified by id. More... | |
int | registerParameterRemovedCallback (VoidLookupKeyFunctor func) |
Registers a callback target function that gets invoked when a control-parameter entry has been removed. More... | |
None | unregisterParameterRemovedCallback (int id) |
Unregisters the callback specified by id. More... | |
int | registerParentChangedCallback (VoidFunctor func) |
Registers a callback target function that gets invoked when the parent container has been changed or was detached. More... | |
None | unregisterParentChangedCallback (int id) |
Unregisters the callback specified by id. More... | |
ControlParameterContainer | getParent () |
Returns a reference to the parent control-parameter container. More... | |
None | setParent (ControlParameterContainer cntnr) |
Sets or removes the parent control-parameter container used to resolve requests for missing entries. More... | |
list | getParameterKeys () |
list | getParameterValues () |
list | getParameters () |
Returns a reference to itself. More... | |
int | getObjectID () |
Returns the numeric identifier (ID) of the wrapped C++ class instance. More... | |
Any | __getitem__ (LookupKey key) |
None | __setitem__ (LookupKey key, Any value) |
bool | __delitem__ (LookupKey self) |
bool | __contains__ (LookupKey self, bool key) |
Returns the result of the membership test operation self in arg1 . More... | |
int | __len__ () |
Additional Inherited Members | |
Properties inherited from CDPL.Base.ControlParameterContainer | |
objectID = property(getObjectID) | |
parent = property(getParent, setParent) | |
parameterKeys = property(getParameterKeys) | |
parameterValues = property(getParameterValues) | |
parameters = property(getParameters) | |
numParameters = property(getNumParameters) | |
The abstract base of classes implementing the 2D visualization of data objects.
Subclasses of View2D
implement the generation of two-dimensional visual representations of data objects with a given type. According to the Model-View-Controller [WMVC] concept, a View2D
instance thus plays the role of the View for a Model represented by the visualized data object. The rendering of a model's visual represention on a given target device is performed by the render() method, which uses a passed Vis.Renderer2DRenderer2D instance for drawing the graphical primitives constituting the overall depiction. The behaviour of a View2D
instance can be configured using control-parameters and properties (if the type of the data object is a direct or indirect subclass of Base.PropertyContainer). Control-parameters can be modified and queried using the methods provided by Base.ControlParameterContainer which is a public base class of View2D
.
None CDPL.Vis.View2D.render | ( | Renderer2D | renderer | ) |
Renders the visual representation of the model using the specified Vis.Renderer2D instance.
renderer | The Renderer2D instance. |
None CDPL.Vis.View2D.setFontMetrics | ( | FontMetrics | font_metrics | ) |
Specifies a font metrics object that will be used to measure the dimension of text labels.
font_metrics | A reference to the font metrics object or None. |
None CDPL.Vis.View2D.getModelBounds | ( | Rectangle2D | bounds | ) |
Calculates the bounding rectangle of the visualized model.
bounds | A Rectangle2D object storing the calculated bounding rectangle. |