java.lang.Object
- WildMagic.LibGraphics.ObjectSystem.GraphicsObject
- - WildMagic.LibGraphics.SceneGraph.Spatial
  - - WildMagic.LibGraphics.SceneGraph.Node

All Implemented Interfaces:

java.io.Serializable, NameIdInterface, StreamInterface

Direct Known Subclasses:

BillboardNode, BspNode, CameraNode, LightNode
```
public class Node
extends Spatial
implements NameIdInterface, StreamInterface, java.io.Serializable
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class WildMagic.LibGraphics.SceneGraph.Spatial
  Spatial.CullingMode

Field Summary

Fields
Modifier and Type Field Description

protected java.util.Vector<Spatial> m_kChild
children

private static long serialVersionUID
- Fields inherited from class WildMagic.LibGraphics.SceneGraph.Spatial
  Culling, Local, m_iStartEffect, m_kEffects, m_kGlobalStates, m_kLights, m_pkParent, World, WorldBound, WorldBoundIsCurrent, WorldIsCurrent

Constructor Summary

Constructors
Constructor Description

Node()
Default construction.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`AttachChild(Spatial pkChild)`	children
`void`	`DetachAllChildren()`	Delete memory.
`int`	`DetachChild(Spatial pkChild)`	children
`Spatial`	`DetachChildAt(int i)`	children
`void`	`dispose()`	Delete memory.
`void`	`GetAllObjectsByName(java.lang.String rkName, java.util.Vector<GraphicsObject> rkObjects)`	Writes all GraphicsObjects with the name that matches the input parameter, rkName into the Vector parameter rkObjects.
`Spatial`	`GetChild(int i)`	children
`int`	`GetDiskUsed(StreamVersion rkVersion)`	Returns the size of this object and it's children on disk for the current StreamVersion parameter.
`GraphicsObject`	`GetObjectByID(int uiID)`	Returns the GraphicsObject with the ID that matches the input parameter, uiID.
`GraphicsObject`	`GetObjectByName(java.lang.String rkName)`	Returns the GraphicsObject with the name that matches the input parameter, rkName.
`int`	`GetQuantity()`	children
`protected void`	`GetVisibleSet(Culler rkCuller, boolean bNoCull)`	culling
`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.
`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.
`Spatial`	`SetChild(int i, Spatial pkChild)`	children
`protected void`	`UpdateState(java.util.Vector<java.util.Vector<GlobalState>> akGStack, java.util.Vector<Light> pkLStack)`	render state updates
`protected void`	`UpdateWorldBound()`	geometric updates
`protected void`	`UpdateWorldData(double dAppTime)`	geometric updates

Methods inherited from class WildMagic.LibGraphics.SceneGraph.Spatial
AttachEffect, AttachGlobalState, AttachLight, DetachAllEffects, DetachAllGlobalStates, DetachAllLights, DetachEffect, DetachGlobalState, DetachLight, GetEffect, GetEffectQuantity, GetGlobalState, GetGlobalState, GetGlobalStateQuantity, GetLight, GetLightQuantity, GetParent, GetStartEffect, OnGetVisibleSet, PopState, PropagateBoundToRoot, PropagateStateFromRoot, PushState, SetParent, SetStartEffect, UpdateBS, UpdateGS, UpdateGS, UpdateRS, UpdateRS

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
  - m_kChild
```
protected java.util.Vector<Spatial> m_kChild
```
    children
- Constructor Detail
  - Node
```
public Node()
```
    Default construction.
- Method Detail
  - AttachChild
```
public int AttachChild(Spatial pkChild)
```
    children
    
    Parameters:
    
    pkChild - child node to add.
    
    Returns:
    
    number of children nodes.
  - DetachAllChildren
```
public void DetachAllChildren()
```
    Delete memory.
  - DetachChild
```
public int DetachChild(Spatial pkChild)
```
    children
    
    Parameters:
    
    pkChild - child node to detach.
    
    Returns:
    
    position of child node, or -1.
  - DetachChildAt
```
public Spatial DetachChildAt(int i)
```
    children
    
    Parameters:
    
    i - position of child node to detach.
    
    Returns:
    
    detached child node.
  - dispose
```
public void dispose()
```
    Delete memory.
    
    Overrides:
    
    dispose in class Spatial
  - GetAllObjectsByName
```
public void GetAllObjectsByName(java.lang.String rkName,
                                java.util.Vector<GraphicsObject> rkObjects)
```
    Writes all GraphicsObjects with the name that matches the input parameter, rkName into the Vector parameter rkObjects.
    
    Specified by:
    
    GetAllObjectsByName in interface NameIdInterface
    
    Overrides:
    
    GetAllObjectsByName in class Spatial
    
    Parameters:
    
    rkName - the name of the objects to return.
    
    rkObjects - a Vector of all objects with the matching name.
  - GetChild
```
public Spatial GetChild(int i)
```
    children
    
    Parameters:
    
    i - position of child node to set.
    
    Returns:
    
    child node at position i, or null.
  - 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 Spatial
    
    Parameters:
    
    rkVersion - the current version of the Stream file being created.
    
    Returns:
    
    the size of this object on disk.
  - GetObjectByID
```
public GraphicsObject GetObjectByID(int uiID)
```
    Returns the GraphicsObject with the ID that matches the input parameter, uiID.
    
    Specified by:
    
    GetObjectByID in interface NameIdInterface
    
    Overrides:
    
    GetObjectByID in class Spatial
    
    Parameters:
    
    uiID - the ID of the object to return.
    
    Returns:
    
    the GraphicsObject that matches the input name.
  - GetObjectByName
```
public GraphicsObject GetObjectByName(java.lang.String rkName)
```
    Returns the GraphicsObject with the name that matches the input parameter, rkName.
    
    Specified by:
    
    GetObjectByName in interface NameIdInterface
    
    Overrides:
    
    GetObjectByName in class Spatial
    
    Parameters:
    
    rkName - the name of the object to return.
    
    Returns:
    
    the GraphicsObject that matches the input name.
  - GetQuantity
```
public final int GetQuantity()
```
    children
    
    Returns:
    
    number of children nodes.
  - 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 Spatial
    
    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 Spatial
    
    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.
  - 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 Spatial
    
    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 Spatial
    
    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 Spatial
    
    Parameters:
    
    acTitle - the header for this object in the StringTree.
    
    Returns:
    
    StringTree containing a String-based representation of this object and it's children.
  - SetChild
```
public Spatial SetChild(int i,
                        Spatial pkChild)
```
    children
    
    Parameters:
    
    i - position of child node to set.
    
    pkChild - child node.
    
    Returns:
    
    previous child node at position i, or null.
  - GetVisibleSet
```
protected void GetVisibleSet(Culler rkCuller,
                             boolean bNoCull)
```
    culling
    
    Specified by:
    
    GetVisibleSet in class Spatial
    
    Parameters:
    
    rkCuller - culling object applied to this node.
    
    bNoCull - when true don't cull.
  - UpdateState
```
protected void UpdateState(java.util.Vector<java.util.Vector<GlobalState>> akGStack,
                           java.util.Vector<Light> pkLStack)
```
    render state updates
    
    Specified by:
    
    UpdateState in class Spatial
    
    Parameters:
    
    akGStack - global states.
    
    akLStack - lights.
  - UpdateWorldBound
```
protected void UpdateWorldBound()
```
    geometric updates
    
    Specified by:
    
    UpdateWorldBound in class Spatial
  - UpdateWorldData
```
protected void UpdateWorldData(double dAppTime)
```
    geometric updates
    
    Overrides:
    
    UpdateWorldData in class Spatial
    
    Parameters:
    
    dAppTime - animation time step from application.

Modifier and Type	Field	Description
`protected java.util.Vector<Spatial>`	`m_kChild`	children
`private static long`	`serialVersionUID`

Class Node

Nested Class Summary

Nested classes/interfaces inherited from class WildMagic.LibGraphics.SceneGraph.Spatial

Field Summary

Fields inherited from class WildMagic.LibGraphics.SceneGraph.Spatial

Constructor Summary

Method Summary

Methods inherited from class WildMagic.LibGraphics.SceneGraph.Spatial

Methods inherited from class WildMagic.LibGraphics.ObjectSystem.GraphicsObject

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

m_kChild

Constructor Detail

Node

Method Detail

AttachChild

DetachAllChildren

DetachChild

DetachChildAt

dispose

GetAllObjectsByName

GetChild

GetDiskUsed

GetObjectByID

GetObjectByName

GetQuantity

Link

Load

Register

Save

SaveStrings

SetChild

GetVisibleSet

UpdateState

UpdateWorldBound

UpdateWorldData