com.bonzaiengine.model

Class GeometryData

java.lang.Object

com.bonzaiengine.model.GeometryData

All Implemented Interfaces:

IDestroyable, IBoundable, ICullable

public final class GeometryData
extends java.lang.Object
implements ICullable, IDestroyable

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Object	physicData User data to store physic informations
HwData	rendererData Used by renderer

Constructor Summary

Constructors

Constructor and Description
GeometryData(FaceData faceData, int materialKey)
GeometryData(FaceData faceData, java.lang.Object materialKey)
GeometryData(FaceData faceData, java.lang.String materialKey)

Method Summary

Modifier and Type	Method and Description
void	destroy(IGLApi glApi)
IMaterial	getMaterial()
KeyRange<VertexData>	getVertexDataRange()
VertexData	getVertices()
IVolume<?>	getVolume(int bvOptions)
boolean	isCulled()
boolean	isDrawBoundingVolume()
boolean	isVisible()
boolean	isVisibleAndNotCulled() Renderer only if visible and not culled
void	onVerticesAccess(boolean useNormals, boolean useTangents)
void	onVerticesChanged(boolean positionChanged) This method must be called when getVertices() has been manually modified.
void	setCulled(boolean culled)
void	setDrawBoundingVolume(boolean drawBoundingVolume)
void	setMaterialKey(AssetKey materialKey)
void	setMaterialKey(int materialKey)
void	setMaterialKey(java.lang.Object materialKey)
void	setMaterialKey(java.lang.String materialKey)
void	setVisible(boolean visible)
java.lang.String	toString()
GeometryData	with(FaceData faceData) Both the original and returned GeometryData must be destroy when not used anymore to keep asset reference counter balanced.
GeometryData	with(VertexData vertices) Both the original and returned GeometryData must be destroy when not used anymore to keep asset reference counter balanced.

Methods inherited from class java.lang.Object

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

Field Detail

physicData

public java.lang.Object physicData

User data to store physic informations

rendererData

public HwData rendererData

Used by renderer

Constructor Detail

GeometryData

public GeometryData(FaceData faceData,
                    java.lang.String materialKey)

GeometryData

public GeometryData(FaceData faceData,
                    int materialKey)

GeometryData

public GeometryData(FaceData faceData,
                    java.lang.Object materialKey)

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

with

public final GeometryData with(VertexData vertices)

Both the original and returned GeometryData must be destroy when not used anymore to keep asset reference counter balanced.
This is done automatically during Model or ModelInstance destruction, but must be done manually when GeometryData is manipulated outside.

Parameters:

vertices -

Returns:

a new GeometryData, a duplicate of this GeometryData with the specified vertices

with

public final GeometryData with(FaceData faceData)

Both the original and returned GeometryData must be destroy when not used anymore to keep asset reference counter balanced.
This is done automatically during Model or ModelInstance destruction, but must be done manually when GeometryData is manipulated outside.

Parameters:

faceData -

Returns:

a new GeometryData, a duplicate of this GeometryData with the specified faceData

destroy

public void destroy(IGLApi glApi)

Specified by:

destroy in interface IDestroyable

getMaterial

public final IMaterial getMaterial()

getVolume

public final IVolume<?> getVolume(int bvOptions)

Specified by:

getVolume in interface IBoundable

Parameters:

bvOptions - bounding volume options.

Returns:

bounding volume, cast to BoundingBox or BoundingSphere depending on options.

See Also:

VolumeOptions, Box, Sphere, Cylinder, Capsule

onVerticesChanged

public final void onVerticesChanged(boolean positionChanged)

This method must be called when getVertices() has been manually modified.

getVertexDataRange

public final KeyRange<VertexData> getVertexDataRange()

onVerticesAccess

public final void onVerticesAccess(boolean useNormals,
                                   boolean useTangents)

getVertices

public final VertexData getVertices()

Returns:

the (immutable) VertexData associated to this GeometryData

setMaterialKey

public final void setMaterialKey(java.lang.String materialKey)

Parameters:

materialKey - a material name, or null

See Also:

setMaterialKey(int), setMaterialKey(AssetKey)

setMaterialKey

public final void setMaterialKey(int materialKey)

Parameters:

materialKey - a material index, or -1

See Also:

setMaterialKey(String), setMaterialKey(AssetKey)

setMaterialKey

public final void setMaterialKey(AssetKey materialKey)

Parameters:

materialKey - a Material key

See Also:

setMaterialKey(String), setMaterialKey(int)

setMaterialKey

public final void setMaterialKey(java.lang.Object materialKey)

Parameters:

materialKey - a material key (int, String, AssetKey)

See Also:

setMaterialKey(String), setMaterialKey(int), setMaterialKey(AssetKey)

isVisibleAndNotCulled

public final boolean isVisibleAndNotCulled()

Renderer only if visible and not culled

isVisible

public final boolean isVisible()

Specified by:

isVisible in interface ICullable

Returns:

true if this GeometryData is visible

setVisible

public final void setVisible(boolean visible)

Parameters:

visible - set new visibility state of this GeometryData

isCulled

public final boolean isCulled()

Specified by:

isCulled in interface ICullable

Returns:

true if this GeometryData is culled (by visibility algorithm, ...)

setCulled

public final void setCulled(boolean culled)

Specified by:

setCulled in interface ICullable

Parameters:

culled - new culled state for this GeometryData

isDrawBoundingVolume

public final boolean isDrawBoundingVolume()

Returns:

true if the renderer must draw a bounding volume around this GeometryData

setDrawBoundingVolume

public final void setDrawBoundingVolume(boolean drawBoundingVolume)