crystalspace.jbind.interfaces.ivideo.halo
Interface iHalo

All Superinterfaces:
iBase, iPointer
All Known Implementing Classes:
csHalo

public interface iHalo
extends iBase

iHalo: used to render halos (aka "light globes"). This interface can be used as well for any scalable semi-transparent 2D sprites. The "halo" is really just an alpha map; the sprite is a single-colored rectangle with more or less transparent portions (depends on alpha map).

Author:
Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/devapi/structiHalo.php

Method Summary
 void draw(float x, float y, float w, float h, float iIntensity, csVector2[] iVertices)
          Draw the halo given a center point and an intensity.
 float[] getColor()
          Query halo color.
 int getHeight()
          Query halo height.
 int getWidth()
          Query halo width.
 void setColor(float iR, float iG, float iB)
          Change halo color.
 
Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase
decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe
 
Methods inherited from interface crystalspace.jbind.interfaces.iPointer
changePointer, getPointer, isMemoryOwner, setMemoryOwner
 

Method Detail

draw

public void draw(float x,
                 float y,
                 float w,
                 float h,
                 float iIntensity,
                 csVector2[] iVertices)
Draw the halo given a center point and an intensity. If either w and/or h is negative, the native width and/or height is used instead. If the halo should be clipped against some polygon, that polygon should be given, otherwise if a 0 pointer is passed, the halo is clipped just against screen bounds.

Parameters:
x -
y -
w -
h -
iIntensity -
iVertices -

getColor

public float[] getColor()
Query halo color.

Returns:

getHeight

public int getHeight()
Query halo height.

Returns:

getWidth

public int getWidth()
Query halo width.

Returns:

setColor

public void setColor(float iR,
                     float iG,
                     float iB)
Change halo color.

Parameters:
iR -
iG -
iB -