SurfaceClipEffect (MIPAV API Documentation)

java.lang.Object
- WildMagic.LibGraphics.ObjectSystem.GraphicsObject
- - WildMagic.LibGraphics.Effects.Effect
  - - WildMagic.LibGraphics.Effects.ShaderEffect
    - - gov.nih.mipav.view.renderer.WildMagic.Render.VolumeClipEffect
      - gov.nih.mipav.view.renderer.WildMagic.Render.SurfaceClipEffect

All Implemented Interfaces:

java.io.Serializable, WildMagic.LibGraphics.ObjectSystem.NameIdInterface, WildMagic.LibGraphics.ObjectSystem.StreamInterface
```
public class SurfaceClipEffect
extends VolumeClipEffect
```
Surface clipping.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

private static long serialVersionUID
- Fields inherited from class gov.nih.mipav.view.renderer.WildMagic.Render.VolumeClipEffect
  CLIP_A, CLIP_A_INV, CLIP_EYE, CLIP_EYE_INV, CLIP_X, CLIP_X_INV, CLIP_Y, CLIP_Y_INV, CLIP_Z, CLIP_Z_INV, m_aafClipData, m_afClipAll, m_afClipOBBAxis0, m_afClipOBBAxis1, m_afClipOBBAxis2, m_afClipOBBExtent, m_afClipSphereCenter, m_afClipSphereScale, m_afDoClip, m_afVolumeMatrix, m_bClipOBB, m_bClipSphere, MAX_CLIP_PLANES
- Fields inherited from class WildMagic.LibGraphics.Effects.ShaderEffect
  m_iPassQuantity, m_kAlphaState, m_kCompiledPrograms, m_kPShader, m_kVShader

Constructor Summary

Constructors
Constructor Description

SurfaceClipEffect()
Create a surface clip effect.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`Scale(float fSX, float fSY, float fSZ, boolean bOn)`	Scale the surface to fit the mask texture.

Methods inherited from class gov.nih.mipav.view.renderer.WildMagic.Render.VolumeClipEffect
dispose, getClip, getClipArb, getClipArbInv, getClipEnable, getClipEye, getClipEyeInv, getClipInv, getClipInvEnable, isClip, isClipAE, isClipOBB, isClipSphere, OnLoadPrograms, ResetClip, SetClip, SetClipArb, SetClipArbInv, SetClipEye, SetClipEyeInv, SetClipOBB, SetClipSphere, setVolumeMatrix

Methods inherited from class WildMagic.LibGraphics.Effects.ShaderEffect
GetAllObjectsByName, GetBlending, GetCProgram, GetDiskUsed, GetObjectByID, GetObjectByName, GetPassQuantity, GetPProgram, GetSamplerInformation, GetTexture, GetTexture, GetTextureQuantity, GetVProgram, Link, Load, LoadPrograms, LoadResources, OnReleasePrograms, Register, ReleasePrograms, ReleaseResources, RestoreGlobalState, Save, SaveStrings, SetCProgram, SetDefaultAlphaState, SetGlobalState, SetPassQuantity, SetPShader, SetVShader

Methods inherited from class WildMagic.LibGraphics.Effects.Effect
Draw

Methods inherited from class WildMagic.LibGraphics.ObjectSystem.GraphicsObject
GetID, GetName, GetNextID, GetObjectByIDBase, GetObjectByNameBase, SetName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SurfaceClipEffect
```
public SurfaceClipEffect()
```
    Create a surface clip effect. Used to generate the surface mask texture.
- Method Detail
  - Scale
```
public void Scale(float fSX,
                  float fSY,
                  float fSZ,
                  boolean bOn)
```
    Scale the surface to fit the mask texture. Scaling is done inside the SurfaceClip vertex shader.
    
    Parameters:
    
    fSX - x-scale factor.
    
    fSY - y-scale factor.
    
    fSZ - z-scale factor.
    
    bOn - turn scale on/off.