|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--yaarq.sys.yrqVisual
|
+--yaarq.sys.yrqEffectVisual
This class extends the yrqVisual class providing support for viewport-oriented effects based on a texture being displayed on a quadrangle geometry which is created automatically. Effect visuals only have a material and a lightmap texture assigned, and they have only brightness for a material color (they are never lighted using the lighting system).
Effect visuals always are added to yrqFrame instances. Effect visuals automatically align to the viewport, resulting in a billboard effect. Their position, however, is determined by the frame they have been attached to.
TODO: Nothing
| Field Summary |
| Fields inherited from class yaarq.sys.yrqVisual |
COLOR_AMBIENT, COLOR_DIFFUSE, COLOR_EMISSIVE, COLOR_SPECULAR, m_parent, MODE_ADD, MODE_BLEND, MODE_NONE, TEXTURE_DOT3BUMP, TEXTURE_LIGHTMAP, TEXTURE_MATERIAL, TEXTURE_REFLECT |
| Constructor Summary | |
yrqEffectVisual(float a_size,
javax.media.j3d.Texture2D a_texMaterial,
javax.media.j3d.Texture2D a_texLightMap,
int a_mode,
float a_transparency,
float a_brightness)
Constructs a effect basic visual using passed parameters. |
|
| Method Summary | |
float |
getSize()
This function retrieves the size of the internal geometry used for the effect |
javax.media.j3d.Texture2D |
getTexture(int a_type)
This function returns one of the textures used in the visual. |
int |
getTransparencyMode()
Returns the transparency mode of the visual. |
float |
getTransparencyValue()
Returns the transparency value for this visual. |
void |
setBrightness(float a_brightness)
This method sets the material of the visual to a greyscale level having defined emissivity. |
void |
setSize(float a_size)
This method sets the size, in world coordinates, of the effects visual geometry. |
void |
setTexture(int a_type,
javax.media.j3d.Texture2D a_texture)
This function sets one of the textures used in the visual. |
void |
setTextureAnimation(double a_left,
double a_top,
double a_width,
double a_height)
This function sets a continuous texture animation to the base material texture. |
void |
setTextureAnimation(int a_clipIndex,
int a_clipCountX,
int a_clipCountY)
This function set a clip-based texture animation to the base material texture. |
void |
setTransparency(float a_alpha,
int a_mode)
Sets the transparency factor for the visual. |
| Methods inherited from class yaarq.sys.yrqVisual |
attach, detach, getBaseShape3D, getBumpShape3D, getGeometry, getParent, setColor, setGeometry, setShininess |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public yrqEffectVisual(float a_size,
javax.media.j3d.Texture2D a_texMaterial,
javax.media.j3d.Texture2D a_texLightMap,
int a_mode,
float a_transparency,
float a_brightness)
a_size - The size of the geometry to use in construction of the visuala_texMaterial - The basic material texturea_texLightMap - The lightmap texture to add with the material texturea_transparency - The alpha-transparency of the constructed visual, 0-1fa_mode - The alpha-transparency mode of the constructed visual, one of the mode_xxx constantsa_brightness - The emissive component of the constructed visual, 0-1f| Method Detail |
public float getSize()
public javax.media.j3d.Texture2D getTexture(int a_type)
getTexture in class yrqVisuala_type - The type of the texture to return. One of the TEXTURE_xxx constants
public int getTransparencyMode()
getTransparencyMode in class yrqVisualpublic float getTransparencyValue()
getTransparencyValue in class yrqVisualpublic void setBrightness(float a_brightness)
The values set by the convenience methods setBrightness and setShininess are only valid until the next call to setColor. Setting individual color components of the visual overrides previous settings.
setBrightness in class yrqVisuala_brightness - The brightness of the visual, 0-1fpublic void setSize(float a_size)
a_size - The size of the geometry internally used for the visual
public void setTexture(int a_type,
javax.media.j3d.Texture2D a_texture)
setTexture in class yrqVisuala_type - The type of the texture to set. One of the TEXTURE_xxx constantsa_texture - The texture to set
public void setTextureAnimation(double a_left,
double a_top,
double a_width,
double a_height)
setTextureAnimation in class yrqVisuala_left - Left clip position, normalized (0-1)a_top - Top clip position, normalized (0-1)a_width - Width of clip to use, normalized (0-1)a_height - Height of clip to use, normalized (0-1)
public void setTextureAnimation(int a_clipIndex,
int a_clipCountX,
int a_clipCountY)
setTextureAnimation in class yrqVisuala_clipIndex - Index of the clip within the texturea_clipCountX - Number of clips in X directiona_clipCountY - Number of clips in Y direction
public void setTransparency(float a_alpha,
int a_mode)
setTransparency in class yrqVisuala_alpha - Global transparency factor for this visuala_mode - Transparency mode for this visual
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||