optics
Class Aperture

java.lang.Object
  optics.Optics
      optics.OpticalSurface
          optics.OpticalPlane
              optics.Aperture

All Implemented Interfaces:

Diagram2DComponent

Direct Known Subclasses:

CircularAperture

public abstract class Aperture
extends OpticalPlane

Abstarct class to represent an aperture being an OpticalPlane which will either pass a ray or block it.

Field Summary

protected Mask

mask The aperture mask

Fields inherited from class optics.OpticalPlane

blockedNormal, maxRadius, planeNormal

Fields inherited from class optics.OpticalSurface

CLEAR, group, REFLECTING, REFRACTING, refractiveIndex, surfacePoint, surfaceType

Fields inherited from class optics.Optics

DEFAULT_WAVELENGTH, errorStream, fmt, MICRONS

Constructor Summary

Aperture()

Method Summary

Mask	getMask() Method to get the current mask
Director	getNormal(Position r) Method to get the normal, will be (0,0,1) if in the clear regions of the aperture, otherwise will be sey to inValid()
void	scale(double a) Method to scale the aperture.
void	setMask(Mask m) Method to set the aperture mask

Methods inherited from class optics.OpticalPlane

clone, distance, draw, getBounds, getCurvature, getEdgePlane, getMaxRadius, getPlaneNormal, pointInPlane, setMaxRadius, setPlaneNormal, toString

Methods inherited from class optics.OpticalSurface

distance, edit, entranceAperture, exitAperture, fromString, fromTokens, getGroup, getIndex, getNormal, getPoint, getRefractiveIndex, getSurfacePoint, getSurfaceType, getSurfaceType, makeStandAlone, pointInPlane, setGroup, setRefractiveIndex, setSurfacePoint, setSurfaceType

Methods inherited from class optics.Optics

getDefaultWaveLength, getErrorStream, getFormatString, getName, getStaticName, getVersion, printError, setDefaultWaveLength, setErrorStream, setFormatString, setMicrons

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mask

protected Mask mask

The aperture mask

Constructor Detail

Aperture

public Aperture()

Method Detail

setMask

public void setMask(Mask m)

Method to set the aperture mask

Parameters:

m - the mask

getMask

public Mask getMask()

Method to get the current mask

Returns:

Mask the current mask

scale

public void scale(double a)

Method to scale the aperture. All parameters except GroupPoint are scaled.

Overrides:

scale in class OpticalPlane

Parameters:

a - the scale factor.

getNormal

public Director getNormal(Position r)

Method to get the normal, will be (0,0,1) if in the clear regions of the aperture, otherwise will be sey to inValid()

Overrides:

getNormal in class OpticalPlane

Parameters:

r - the position on the surface

Returns:

Director normal director.