Package esys :: Package pyvisi :: Module legend :: Class Legend

Class Legend

 scalarbar.ScalarBar --+
                       |
mapper.DataSetMapper --+
                       |
       actor.Actor3D --+
                       |
                      Legend

Class that shows a scalar field on a domain surface. The domain surface can either be colored or grey-scaled, depending on the lookup table used.

Instance Methods

[hide private]

__init__(self, scene, data_collector, viewport=0, lut='color', legend='scalar')
Initialise the Legend.

Boolean

_isModified(self)
Return whether the Legend or DataCollector has been modified.

_render(self, scene)
Render the legend.

Inherited from scalarbar.ScalarBar: labelBoldOff, labelBoldOn, setHeight, setLabelColor, setNumberOfLabels, setOrientationToHorizontal, setOrientationToVertical, setPosition, setTitle, setTitleColor, setWidth, titleBoldOff, titleBoldOn

Inherited from scalarbar.ScalarBar (private): _getScalarBar, _setScalarBarLookupTable

Inherited from mapper.DataSetMapper: setScalarRange

Inherited from mapper.DataSetMapper (private): _getDataSetMapper, _getDataSetMapperLookupTable, _getDataSetMapperRange, _isScalarRangeSet, _setScalarRange, _setScalarVisibilityOn, _setupDataSetMapper

Inherited from actor.Actor3D: setColor, setOpacity, setRepresentationToWireframe

Inherited from actor.Actor3D (private): _getActor3D, _setLineWidth, _setTexture, _setupActor3D

Method Details

[hide private]

init(self, scene, data_collector, viewport=0, lut=`'color'`, legend=`'scalar'`)
(Constructor)

Initialise the Legend.

Parameters:

scene (Scene object) - Scene in which objects are to be rendered on
data_collector (DataCollector object) - Deal with source of data for vizualisation
viewport (Viewport constant) - Viewport in which objects are to be rendered on
lut (Lut constant) - Lookup table color scheme
legend (Lut constant) - Type of legend

Overrides: actor.Actor3D.__init__

_isModified(self)

Return whether the Legend or DataCollector has been modified.

Returns: Boolean: True or False

_render(self, scene)

Render the legend.

Parameters:

scene (Scene object) - Scene in which objects are to be rendered on

Class Legend

__init__(self, scene, data_collector, viewport=0, lut='color', legend='scalar') (Constructor)

_isModified(self)

_render(self, scene)

init(self, scene, data_collector, viewport=0, lut=`'color'`, legend=`'scalar'`)
(Constructor)