Package esys :: Package pyvisi :: Module ellipsoid :: Class EllipsoidOnPlaneClip
[hide private]
[frames] | no frames]

Class EllipsoidOnPlaneClip

mapper.DataSetMapper --+
                       |
       actor.Actor3D --+
                       |
       sphere.Sphere --+
                       |
     normals.Normals --+
                       |
   glyph.TensorGlyph --+
                       |
 transform.Transform --+
                       |
         plane.Plane --+
                       |
     clipper.Clipper --+
                       |
    point.MaskPoints --+
                       |
                      EllipsoidOnPlaneClip

This class works in a similar way to MapOnPlaneClip, except that it shows a tensor field using ellipsoids 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 EllipsoidOnPlaneClip.
Boolean
_isModified(self)
Return whether the EllipsoidOnPlaneClip or DataCollector has been modified.
 
_render(self, scene)
Render the ellipsoids clip using a plane.

Inherited from mapper.DataSetMapper: setScalarRange

Inherited from actor.Actor3D: setColor, setOpacity, setRepresentationToWireframe

Inherited from sphere.Sphere: setPhiResolution, setThetaResolution

Inherited from sphere.Sphere (private): _getSphereOutput

Inherited from normals.Normals (private): _getNormalsOutput, _setupNormals

Inherited from glyph.TensorGlyph: setMaxScaleFactor, setScaleFactor

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 point.MaskPoints: randomOff, randomOn, setRatio

Method Details [hide private]

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

 

Initialise the EllipsoidOnPlaneClip.

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 object 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).

_isModified(self)

 

Return whether the EllipsoidOnPlaneClip or DataCollector has been modified.

Returns: Boolean
True or False

_render(self, scene)

 

Render the ellipsoids clip using a plane.

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