org.xith3d.scenegraph
Class InheritedNodeAttributes

java.lang.Object
  extended by org.xith3d.scenegraph.InheritedNodeAttributes

public final class InheritedNodeAttributes
extends java.lang.Object

the InheritedNodeAttributes class holds references to inherited Nodes like lights, fog, etc. Each SceneGraph Node carries an instance of this class, which is automatically updated and which is read-only for non-scenegraph classes.


Constructor Summary
InheritedNodeAttributes()
           
 
Method Summary
protected  void addFog(Fog fog)
           
protected  void addLight(Light light)
           
 ClipperInfo getClipper()
           
 int getEffectiveFogsCount()
           
 int getEffectiveLightsCount()
           
 Fog getFog(int index)
           
 int getFogsCount()
           
 boolean getFogsDirty()
           
 Light getLight(int index)
           
 int getLightsCount()
           
 boolean getLightsDirty()
           
 ScissorRect getScissorRect()
           
protected  void merge(InheritedNodeAttributes toMerge)
           
protected  void removeFog(Fog fog)
           
protected  void removeLight(Light light)
           
protected  void setClipper(ClipperInfo clipper)
           
 void setFogsClean()
           
 void setLightsClean()
           
protected  void setScissorRect(ScissorRect scissorRect)
           
protected  void unmerge(InheritedNodeAttributes toUnmerge)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InheritedNodeAttributes

public InheritedNodeAttributes()
Method Detail

addLight

protected final void addLight(Light light)

removeLight

protected final void removeLight(Light light)

getLightsCount

public final int getLightsCount()
Returns:
the number of (inherited) Lights in the owning Node.

getEffectiveLightsCount

public final int getEffectiveLightsCount()
Returns:
the number of (inherited) Lights in the owning Node, but with a maximum of 8.

getLight

public final Light getLight(int index)
Returns:
the i-th (inherited) Light in the owning Node.

getLightsDirty

public final boolean getLightsDirty()

setLightsClean

public final void setLightsClean()

addFog

protected final void addFog(Fog fog)

removeFog

protected final void removeFog(Fog fog)

getFogsCount

public final int getFogsCount()
Returns:
the number of (inherited) Fogs in the owning Node.

getEffectiveFogsCount

public final int getEffectiveFogsCount()
Returns:
the number of (inherited) Fogs in the owning Node, but with a maximum of 1.

getFog

public final Fog getFog(int index)
Returns:
the i-th (inherited) Fog in the owning Node.

getFogsDirty

public final boolean getFogsDirty()

setFogsClean

public final void setFogsClean()

setScissorRect

protected final void setScissorRect(ScissorRect scissorRect)

getScissorRect

public final ScissorRect getScissorRect()
Returns:
the (inherited) ScissorRect of the owning Node.

setClipper

protected final void setClipper(ClipperInfo clipper)

getClipper

public final ClipperInfo getClipper()
Returns:
the (inherited) ClipperInfo of the owning Node.

merge

protected void merge(InheritedNodeAttributes toMerge)

unmerge

protected void unmerge(InheritedNodeAttributes toUnmerge)