Package org.scilab.forge.scirenderer.clipping

Interface ClippingPlane

All Known Implementing Classes:

G2DClippingPlane, JoGLClippingPlane

public interface ClippingPlane

Author:

Pierre Lando

Method Summary

Modifier and Type	Method	Description
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.

Method Detail

isEnable

boolean isEnable()

Return the status of this clipping plane.

Returns:

the status of this clipping plane.

setEnable

void setEnable(boolean isEnable)

Set the status of this clipping plane.

Parameters:

isEnable - new status of this clipping plane.

setEquation

void setEquation(Vector4d v)

Set the clipping plane equation.

Parameters:

v - the plane coordinate.

getEquation

Vector4d getEquation()

Return the plane equation.

Returns:

the plane equation.

setTransformation

void setTransformation(Transformation transformation)

Set the coordinate transformation for the plane.

Parameters:

transformation - the new coordinate transformation for the plane.

getTransformation

Transformation getTransformation()

Return the coordinate transformation for the plane.

Returns:

the coordinate transformation for the plane.

getIndex

int getIndex()

Return the clipping plane index.

Returns:

the clipping plane index.s