net.dzzd.access
Interface ISceneObject

All Superinterfaces:

IMonitoredSceneObject

All Known Subinterfaces:

ICamera3D, ILight3D, IMaterial, IMesh3D, IScene2DObject, IScene3DObject, IShape2D, ISolidSphere3D, ITexture, IURLTexture

public interface ISceneObject

extends IMonitoredSceneObject

Used for accessing a scene SceneObject.
Scene objects include all object that can be added and managed by a Scene3D : Texture,Mesh,Animation,Material,etc...

Version:

1.0, 01/01/04

Author:

Bruno Augier

See Also:

IScene3D, IScene3DObject

Method Summary

void	build() Build this object and update its internal built version.
void	clearProperties() Remove all properties for this SceneObject.
void	copy(ISceneObject source) Copy source SceneObject in this SceneObject.
int	getBuild() Gets this object built version.
int	getId() Gets Id.
java.lang.String	getName() Gets name.
java.lang.Object	getProperty(java.lang.String key) Sets a property for this SceneObject.
IScene	getScene() Gets Scene owner, null if object has not been added to a Scene.
void	setBuild(int build) Sets this object built version.
void	setId(int id) Sets Id.
void	setName(java.lang.String name) Sets name.
void	setProperty(java.lang.String key, java.lang.Object value) Sets a property for this SceneObject.

Methods inherited from interface net.dzzd.access.IMonitoredSceneObject

copy

Method Detail

getScene

public IScene getScene()

Gets Scene owner, null if object has not been added to a Scene.

Returns:

Scene owner, null if not in a Scene

getId

public int getId()

Gets Id.
object identifier (Id) are used internaly by the renderer, you may not change it.

Returns:

object Id

setId

public void setId(int id)

Sets Id.
object identifier (Id) are used internaly by the renderer, you may not change it.

Parameters:

id - new object Id

getName

public java.lang.String getName()

Gets name.

Returns:

object name

setName

public void setName(java.lang.String name)

Sets name.

Parameters:

name - new object name

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Sets a property for this SceneObject.
use null as value to remove a single property using its key.

Parameters:

key - key that can be used to retrieve that property

value - object to store as a property for this SceneObject

getProperty

public java.lang.Object getProperty(java.lang.String key)

Sets a property for this SceneObject.

Parameters:

key - to retrieve property for

Returns:

object that have been stored with the given key

clearProperties

public void clearProperties()

Remove all properties for this SceneObject.

build

public void build()

Build this object and update its internal built version.
internal built version maybe used by Render3D or other object to now if an object has been updated.

getBuild

public int getBuild()

Gets this object built version.
if version returned of -1 means that object has never been built or must be rebuilt.

Returns:

internal built version maybe used by Render3D or other object to now if an object has been updated.

setBuild

public void setBuild(int build)

Sets this object built version.
version -1 means that object has never been built or must be rebuilt.

Parameters:

build - internal built version maybe used by Render3D or other object to now if an object has been updated.

copy

public void copy(ISceneObject source)

Copy source SceneObject in this SceneObject.
Copy most properties from source to destination.

Returns:

this SceneObject with new properties copied from source