org.scilab.forge.scirenderer.implementation.g2d.clipping
Class G2DClippingPlane

java.lang.Object
  extended by org.scilab.forge.scirenderer.implementation.g2d.clipping.G2DClippingPlane
All Implemented Interfaces:
ClippingPlane

public class G2DClippingPlane
extends java.lang.Object
implements ClippingPlane

Author:
Pierre Lando

Constructor Summary
G2DClippingPlane(int index, G2DDrawingTools drawingTools)
          Default constructor.
 
Method Summary
 Vector4d getEquation()
          Return the plane equation.
 int getIndex()
          Return the clipping plane index.
 Transformation getTransformation()
          Return the coordinate transformation for the plane.
 boolean isEnable()
          Return the status of this clipping plane.
 void setEnable(boolean isEnable)
          Set the status of this clipping plane.
 void setEquation(Vector4d v)
          Set the clipping plane equation.
 void setTransformation(Transformation transformation)
          Set the coordinate transformation for the plane.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

G2DClippingPlane

public G2DClippingPlane(int index,
                        G2DDrawingTools drawingTools)
Default constructor.

Parameters:
index - the id of this clipping plane.
Method Detail

isEnable

public boolean isEnable()
Description copied from interface: ClippingPlane
Return the status of this clipping plane.

Specified by:
isEnable in interface ClippingPlane
Returns:
the status of this clipping plane.

setEnable

public void setEnable(boolean isEnable)
Description copied from interface: ClippingPlane
Set the status of this clipping plane.

Specified by:
setEnable in interface ClippingPlane
Parameters:
isEnable - new status of this clipping plane.

setEquation

public void setEquation(Vector4d v)
Description copied from interface: ClippingPlane
Set the clipping plane equation.

Specified by:
setEquation in interface ClippingPlane
Parameters:
v - the plane coordinate.

getEquation

public Vector4d getEquation()
Description copied from interface: ClippingPlane
Return the plane equation.

Specified by:
getEquation in interface ClippingPlane
Returns:
the plane equation.

setTransformation

public void setTransformation(Transformation transformation)
Description copied from interface: ClippingPlane
Set the coordinate transformation for the plane.

Specified by:
setTransformation in interface ClippingPlane
Parameters:
transformation - the new coordinate transformation for the plane.

getTransformation

public Transformation getTransformation()
Description copied from interface: ClippingPlane
Return the coordinate transformation for the plane.

Specified by:
getTransformation in interface ClippingPlane
Returns:
the coordinate transformation for the plane.

getIndex

public int getIndex()
Description copied from interface: ClippingPlane
Return the clipping plane index.

Specified by:
getIndex in interface ClippingPlane
Returns:
the clipping plane index.s