Package WildMagic.LibGraphics.Effects

Class MaterialTextureEffect

java.lang.Object

WildMagic.LibGraphics.ObjectSystem.GraphicsObject

WildMagic.LibGraphics.Effects.Effect

WildMagic.LibGraphics.Effects.ShaderEffect

WildMagic.LibGraphics.Effects.MaterialTextureEffect

All Implemented Interfaces:

java.io.Serializable, NameIdInterface, StreamInterface

public class MaterialTextureEffect
extends ShaderEffect
implements StreamInterface, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID

Fields inherited from class WildMagic.LibGraphics.Effects.ShaderEffect

m_iPassQuantity, m_kAlphaState, m_kCompiledPrograms, m_kPShader, m_kVShader

Constructor Summary

Constructors

Constructor	Description
MaterialTextureEffect()	streaming constructor
MaterialTextureEffect(java.lang.String rkBaseName)	Creates a new MaterialTextureEffect with the texture stored in the rkBaseName image file.

Method Summary

Modifier and Type	Method	Description
int	GetDiskUsed(StreamVersion rkVersion)	Returns the size of this object and it's children on disk for the current StreamVersion parameter.
void	Link(Stream rkStream, Stream.Link pkLink)	Copies this objects children objects from the input Stream's HashTable, based on the LinkID of the child stored in the pkLink parameter.
void	Load(Stream rkStream, Stream.Link pkLink)	Loads this object from the input parameter rkStream, using the input Stream.Link to store the IDs of children objects of this object for linking after all objects are loaded from the Stream.
void	OnLoadPrograms(int iPass, Program pkVProgram, Program pkPProgram, Program pkCProgram)	This function is called in LoadPrograms once the shader programs are created.
boolean	Register(Stream rkStream)	Registers this object with the input Stream parameter.
void	Save(Stream rkStream)	Write this object and all it's children to the Stream.
StringTree	SaveStrings(java.lang.String acTitle)	Write this object into a StringTree for the scene-graph visualization.

Methods inherited from class WildMagic.LibGraphics.Effects.ShaderEffect

dispose, GetAllObjectsByName, GetBlending, GetCProgram, GetObjectByID, GetObjectByName, GetPassQuantity, GetPProgram, GetSamplerInformation, GetTexture, GetTexture, GetTextureQuantity, GetVProgram, LoadPrograms, LoadResources, OnReleasePrograms, ReleasePrograms, ReleaseResources, RestoreGlobalState, 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

MaterialTextureEffect

public MaterialTextureEffect()

streaming constructor

MaterialTextureEffect

public MaterialTextureEffect(java.lang.String rkBaseName)

Creates a new MaterialTextureEffect with the texture stored in the rkBaseName image file.

Parameters:

rkBaseName - the image file containing the texture for this Effect.

Method Detail

GetDiskUsed

public int GetDiskUsed(StreamVersion rkVersion)

Returns the size of this object and it's children on disk for the current StreamVersion parameter.

Specified by:

GetDiskUsed in interface StreamInterface

Overrides:

GetDiskUsed in class ShaderEffect

Parameters:

rkVersion - the current version of the Stream file being created.

Returns:

the size of this object on disk.

Link

public void Link(Stream rkStream,
                 Stream.Link pkLink)

Copies this objects children objects from the input Stream's HashTable, based on the LinkID of the child stored in the pkLink parameter.

Specified by:

Link in interface StreamInterface

Overrides:

Link in class ShaderEffect

Parameters:

rkStream - the Stream where the child objects are stored.

pkLink - the Link class from which the child object IDs are read.

Load

public void Load(Stream rkStream,
                 Stream.Link pkLink)

Loads this object from the input parameter rkStream, using the input Stream.Link to store the IDs of children objects of this object for linking after all objects are loaded from the Stream.

Specified by:

Load in interface StreamInterface

Overrides:

Load in class ShaderEffect

Parameters:

rkStream - the Stream from which this object is being read.

pkLink - the Link class for storing the IDs of this object's children objects.

OnLoadPrograms

public void OnLoadPrograms(int iPass,
                           Program pkVProgram,
                           Program pkPProgram,
                           Program pkCProgram)

Description copied from class: ShaderEffect

This function is called in LoadPrograms once the shader programs are created. It gives the ShaderEffect-derived classes a chance to do any additional work to hook up the effect with the low-level objects.

Overrides:

OnLoadPrograms in class ShaderEffect

Parameters:

iPass - the ith rendering pass

Register

public boolean Register(Stream rkStream)

Registers this object with the input Stream parameter. All objects streamed to disk are registered with the Stream so that a unique list of objects is maintained.

Specified by:

Register in interface StreamInterface

Overrides:

Register in class ShaderEffect

Parameters:

rkStream - the Stream where the child objects are stored.

Returns:

true if this object is registered, false if the object has already been registered.

Save

public void Save(Stream rkStream)

Write this object and all it's children to the Stream.

Specified by:

Save in interface StreamInterface

Overrides:

Save in class ShaderEffect

Parameters:

rkStream - the Stream where the child objects are stored.

SaveStrings

public StringTree SaveStrings(java.lang.String acTitle)

Write this object into a StringTree for the scene-graph visualization.

Specified by:

SaveStrings in interface StreamInterface

Overrides:

SaveStrings in class ShaderEffect

Parameters:

acTitle - the header for this object in the StringTree.

Returns:

StringTree containing a String-based representation of this object and it's children.