esys.pyvisi.velocity.VelocityOnPlaneClip

Class VelocityOnPlaneClip

This class works in a similar way to MapOnPlaneClip , except that it shows a vector field using arrows clipped using a plane.

init(self, scene, data_collector, arrow=`'2d'`, color_mode=`'vector'`, viewport=0, lut=`'color'`, cell_to_point=False, outline=True)
(Constructor)

Initialise the VelocityOnPlaneClip.

Parameters:

scene (Scene object) - Scene in which objects are to be rendered on
data_collector (DataCollector object) - Deal with source of data for visualisation
arrow (Arrow constant) - Type of arrow (two dimensional or three dimensional)
color_mode (ColorMode constant) - Type of color mode
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: point.MaskPoints.__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). On occasions, an inaccurate object may be rendered from cell data even after conversion.

_isModified(self)

Return whether the VelocityOnPlaneClip or DataCollector has been modified.

Returns: Boolean: True or False

_render(self, scene)

Render the velocity clip using a plane..

Parameters:

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

Class VelocityOnPlaneClip

__init__(self, scene, data_collector, arrow='2d', color_mode='vector', viewport=0, lut='color', cell_to_point=False, outline=True) (Constructor)

_isModified(self)

_render(self, scene)

init(self, scene, data_collector, arrow=`'2d'`, color_mode=`'vector'`, viewport=0, lut=`'color'`, cell_to_point=False, outline=True)
(Constructor)