Package mmLib :: Module Viewer :: Class GLObject
[hide private]
[frames] | no frames]

Class GLObject

source code

object --+
         |
        GLObject
Known Subclasses:

Base class for all OpenGL rendering objects. It combines a composite-style tree structure with a system for setting properties. The properties are used for the specific OpenGL drawing objects to control color, position, line width, etc... Implementing properties requres the GLProperties object which is the access object for the properties.

Instance Methods [hide private]
 
__init__(self, **args)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
glo_name(self)
Returns the GLObject name.
source code
 
glo_set_name(self, name)
Sets the GLObject name.
source code
 
glo_add_child(self, child) source code
 
glo_prepend_child(self, child)
Adds a child GLObject to the beginning of the GLObject's child list.
source code
 
glo_append_child(self, child)
Adds a child GLObject to the end of the GLObject's child list.
source code
 
glo_remove_child(self, child)
Removes the child GLObject.
source code
 
glo_remove(self)
The GLObject removes itself from its parent.
source code
 
glo_iter_children(self)
Iterate immediate children.
source code
 
glo_iter_preorder_traversal(self)
Preorder Traversal for GLObject composite.
source code
 
glo_get_depth(self)
Returns the depth, the root composite is depth 0.
source code
 
glo_get_degree(self)
Returns the number of children (degree).
source code
 
glo_count_descendants(self)
Counts all decendant GLObjects.
source code
 
glo_get_root(self)
Returns the root GLObject.
source code
 
glo_get_parent(self)
Returns the parent GLObject.
source code
 
glo_get_path(self)
Returns the tree-path to the composite as a list of its parent composites.
source code
 
glo_get_index_path(self)
Returns the tree-path to the GLObject as a list of its integer indexes.
source code
 
glo_get_parent_list(self)
Returns a list of the parent GLObjects back to the root.
source code
 
glo_get_lowest_common_ancestor(self, gl_object)
Returns the lowest common ancesotry of self and argument composite.
source code
 
glo_is_descendant_of(self, gl_object)
Returns true if self composite is a decent of argument GLObject.
source code
 
glo_set_properties_id(self, gl_object_id)
Set the property name for this GLObject.
source code
 
glo_get_properties_id(self)
Returns the properties ID of this object.
source code
 
glo_install_properties(self)
Called by GLObject.__init__ to install properties.
source code
 
glo_add_property(self, prop_desc)
Adds a new property to the GLObject.
source code
 
glo_iter_property_desc(self)
Iterates over all property descriptions.
source code
 
glo_get_property_desc(self, name)
Return the property description dictionary for the given property name.
source code
 
glo_link_child_property(self, name, child_gl_object_id, child_name)
Link the value of the GLObject's property to the value of a child property.
source code
 
glo_get_child(self, gl_object_id)
Returns the child GLObject matching the given gl_object_id.
source code
 
glo_get_child_path(self, glo_id_path)
Returns the object at the given path, or None if the object does not exist.
source code
 
glo_init_properties(self, **args)
This is a special form of update which propagates all linked values, not just the changed ones.
source code
 
glo_update_properties(self, **args)
Update property values and trigger update callbacks.
source code
 
glo_update_properties_path(self, glo_id_path, value) source code
 
glo_add_update_callback(self, func)
Adds a function which is called whenever property values change.
source code
 
glo_remove_update_callback(self, func)
Removes the update callback.
source code
 
glo_get_glstructure(self)
Returns the parent GLStructure object, or None if the GLObject is not a child of a GLStructure.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  PropertyDefault = GLPropertyDefault()
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **args)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

glo_add_property(self, prop_desc)

source code 

Adds a new property to the GLObject. The prop_desc is a dictionary with attributes describing the property. See comments in source code for a description of the key values for property descriptions.

glo_add_update_callback(self, func)

source code 

Adds a function which is called whenever property values change. The function is called with two arguments: a updates dictionary containing all updated properties and the values they were changed to, and a actions list which contains a unique list of action key words forme self.prop_list = [] self.callback_list = [] from the action fields of the updated properties.