Package schrodinger :: Package graphics3d :: Module common :: Class Primitive

Class Primitive

object --+
         |
        Primitive

Known Subclasses:

All 3D objects derive from this class.

Instance Methods

[hide private]

__init__(self, maestro_objects=[])
x.__init__(...) initializes x; see help(type(x)) for signature

__del__(self)

hide(self)
Hide the object.

show(self)
Display this object, if it was hidden

groupHidden(self)
Called when the group of this object is hidden.

groupShown(self)
Called when the group of this object is shown.

isShown(self)
Returns True if this object shown.

isGroupShown(self)
Returns True if this object's group is shown.

setEntryID(self, entry_id)
Sets entry ID for Maestro object (necessary to render in tile-by-entry mode.

setRightClickOnGObject(self, pymodule, pyfunc)
Sets the python callback which should be called whenever given graphics object is right clicked.

setIsGlowing(self, is_glowing)
Enables or disables glow effect for the object.

setGlowColor(self, r, g, b)
Sets glow color for the object.

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, maestro_objects=`[]`)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

hide(self)

Hide the object. It will not be drawn when the group is drawn.

groupHidden(self)

Called when the group of this object is hidden. Hide the Maestro object(s).

groupShown(self)

Called when the group of this object is shown. Show the Maestro object, if we are being shown.

isShown(self)

Returns True if this object shown. False otherwise.

isGroupShown(self)

Returns True if this object's group is shown. False otherwise.

setEntryID(self, entry_id)

Sets entry ID for Maestro object (necessary to render in tile-by-entry mode.

Parameters:

entry_id (str) - Object's entry ID.

setRightClickOnGObject(self, pymodule, pyfunc)

Sets the python callback which should be called whenever given graphics object is right clicked.

Parameters:

pymodule (str) - Python module
pyfunc (str) - Python function

setIsGlowing(self, is_glowing)

Enables or disables glow effect for the object.

Parameters:

is_glowing (bool) - Whether the object is glowing.

setGlowColor(self, r, g, b)

Sets glow color for the object.

Parameters:

r (float) - Red component of glow color [0.0 .. 1.0]
g (float) - Green component of glow color [0.0 .. 1.0]
b (float) - Blue component of glow color [0.0 .. 1.0]

Class Primitive

__init__(self, maestro_objects=[]) (Constructor)

hide(self)

groupHidden(self)

groupShown(self)

isShown(self)

isGroupShown(self)

setEntryID(self, entry_id)

setRightClickOnGObject(self, pymodule, pyfunc)

setIsGlowing(self, is_glowing)

setGlowColor(self, r, g, b)

init(self, maestro_objects=`[]`)
(Constructor)