Package esys :: Package pyvisi :: Module contour :: Class ContourOnPlaneClip

Class ContourOnPlaneClip

       mapper.DataSetMapper --+
                              |
              actor.Actor3D --+
                              |
contourmodule.ContourModule --+
                              |
        transform.Transform --+
                              |
                plane.Plane --+
                              |
            clipper.Clipper --+
                              |
                             ContourOnPlaneClip

This class works in a similar way to MapOnPlaneClip , except that it shows a scalar field by contour surfaces clipped using a plane.

Instance Methods

[hide private]

__init__(self, scene, data_collector, viewport=0, lut='color', cell_to_point=False, outline=True)
Initialise the ContourOnPlaneClip.

Boolean

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

_render(self, scene)
Render the contour clip using a plane.

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

Inherited from contourmodule.ContourModule: generateContours

Inherited from contourmodule.ContourModule (private): _generateContours, _getContourModuleOutput, _isContoursSet, _isLowerRangeSet, _isUpperRangeSet, _setupContourModule

Inherited from transform.Transform: rotateX, rotateY, rotateZ, setPlaneToXY, setPlaneToXZ, setPlaneToYZ, translate

Inherited from transform.Transform (private): _getTransform

Inherited from plane.Plane (private): _getPlane, _setupPlane

Inherited from clipper.Clipper: setClipValue, setInsideOutOff, setInsideOutOn

Inherited from clipper.Clipper (private): _getClipperOutput, _setClipFunction, _setupClipper

Method Details

[hide private]

init(self, scene, data_collector, viewport=0, lut=`'color'`, cell_to_point=False, outline=True)
(Constructor)

Initialise the ContourOnPlaneClip.

Parameters:

scene (Scene object) - Scene in which objects are to be rendered on
data_collector (DataCollector object) - Deal with source of data for visualisation
viewport (Viewport constant) - Viewport in which objects are to be rendered on
lut (Lut constant) - Lookup table color scheme
cell_to_point (Boolean) - Converts cell data to point data (by averaging)
outline (Boolean) - Places an outline around the domain surface

Overrides: clipper.Clipper.__init__

Attention: The source can either be point or cell data. If the source is cell data, a conversion to point data may or may not be required, in order for the object to be rendered correctly. If a conversion is needed, the 'cell_to_point' flag must be set to 'True', otherwise 'False' (which is the default).

_isModified(self)

Return whether the ContourOnPlaneClip or DataCollector has been modified.

Returns: Boolean: True or False

_render(self, scene)

Render the contour clip using a plane.

Parameters:

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

Class ContourOnPlaneClip

__init__(self, scene, data_collector, viewport=0, lut='color', cell_to_point=False, outline=True) (Constructor)

_isModified(self)

_render(self, scene)

init(self, scene, data_collector, viewport=0, lut=`'color'`, cell_to_point=False, outline=True)
(Constructor)