INode

All Known Implementing Classes:

GNode
```
public interface INode
```
Interface representation of a node in a scene. A node is an element in a scene that can contain other nodes, such: as child nodes, attachments which provide new capabilities (rendering, control, etc.) and properties which can be used to define node specific attributes.

Author:

Tony McCrary (tmccrary@l33tlabs.com)

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String RENDERER_NODE_PROP
Property key for accessing the associated renderer node.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`RENDERER_NODE_PROP` Property key for accessing the associated renderer node.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addChild(INode node)` Adds a node to this node as a child node.
`void`	`attach(IAttachment attachment)` Adds the supplied attachment to this node.
`void`	`detach(IAttachment attachment)` Removes the supplied attachment to this node.
`java.util.Map<java.lang.Class<?>,java.util.List<IAttachment>>`	`getAttachments()` Returns a Map of all the node's attachments.
`java.util.List<IAttachment>`	`getAttachments(java.lang.Class<?> clazz)` Returns a List of the node's attachments that are of the supplied type.
`java.util.List<INode>`	`getChildren(boolean copy)` Returns a List of this node's children, optionally returning a copy of the List.
`java.lang.String`	`getName()` Returns the human readable name of the node.
`INode`	`getParent()` Returns the parent of the node, or null if the node is not associated with a parent.
`java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()` Returns a Map of the node's current properties.
`java.lang.Object`	`getProperty(java.lang.String key)` Returns the node property of the specified type or null if the property doesn't exist.
`boolean`	`hasAttachment(java.lang.Class<?> attachmentClass)` Returns true if this node has an attachment of the supplied class type.
`boolean`	`hasProperty(java.lang.String key)` Returns true if the property has been set on this object, false otherwise.
`boolean`	`isVisible()` Returns if the node is visible.
`void`	`removeAllChildren()` Removes all children from this node.
`void`	`removeChild(INode node)` Removes the supplied node as a child from this node.
`void`	`setParent(INode parent)` Sets the parent of the node.
`void`	`setProperty(java.lang.String key, java.lang.Object value)` Sets the property identified by the key String to the supplied value.
`void`	`setVisible(boolean visible)` Sets the visibility of the node.
`boolean`	`supports(IAttachment attachment)` Returns true if the node supports the supplied attachment.

- Field Detail
  - RENDERER_NODE_PROP
```
static final java.lang.String RENDERER_NODE_PROP
```
    Property key for accessing the associated renderer node.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getParent
```
INode getParent()
```
    Returns the parent of the node, or null if the node is not associated with a parent.
    
    Returns:
    
    the parent of the node
  - setParent
```
void setParent(INode parent)
```
    Sets the parent of the node.
    
    Parameters:
    
    parent - the parent of the node to set
  - getName
```
java.lang.String getName()
```
    Returns the human readable name of the node.
    
    Returns:
    
    a String containing the human readable name of the node.
  - addChild
```
void addChild(INode node)
```
    Adds a node to this node as a child node. Once the child has been added, the child node will be linked to the parent for transforms and other operations.
    
    Parameters:
    
    node - node to add as child
  - removeChild
```
void removeChild(INode node)
```
    Removes the supplied node as a child from this node. If node is not currently a child, this is a no-op.
    
    Parameters:
    
    node - node to remove as child
  - removeAllChildren
```
void removeAllChildren()
```
    Removes all children from this node.
    
    Parameters:
    
    node - removes all children from this node.
  - getChildren
```
java.util.List<INode> getChildren(boolean copy)
```
    Returns a List of this node's children, optionally returning a copy of the List.
    
    Returns:
    
    copy if true, the list will be a copy of the node's internal List. if false, the list will be a reference to the internal List.
  - setVisible
```
void setVisible(boolean visible)
```
    Sets the visibility of the node. If the node is not visible, it will not show up in a viewport.
    
    Parameters:
    
    visible - if true, the node will be rendered in visualizations. if false, the node will not be rendered.
  - isVisible
```
boolean isVisible()
```
    Returns if the node is visible.
    
    Returns:
    
    true if the node is visible, false otherwise.
  - attach
```
void attach(IAttachment attachment)
```
    Adds the supplied attachment to this node. The attachment's functionality will be applied to this node.
    
    Parameters:
    
    attachment - the attachment to attach
  - detach
```
void detach(IAttachment attachment)
```
    Removes the supplied attachment to this node. The attachment's functionality with be removed from this node.
    
    If the attachment is not currently attached, this is a no-op.
    
    Parameters:
    
    attachment - the attachment to remove.
  - hasAttachment
```
boolean hasAttachment(java.lang.Class<?> attachmentClass)
```
    Returns true if this node has an attachment of the supplied class type.
    
    Parameters:
    
    attachmentClass - the attachment class to check for.
    
    Returns:
    
    true if the attachment type exists in this node, false otherwise.
  - supports
```
boolean supports(IAttachment attachment)
```
    Returns true if the node supports the supplied attachment. Some attachments may not be used together.
    
    Parameters:
    
    attachment - the attachment to check for
    
    Returns:
    
    true if the node supports the attachment, false otherwise
  - getAttachments
```
java.util.Map<java.lang.Class<?>,java.util.List<IAttachment>> getAttachments()
```
    Returns a Map of all the node's attachments.
    
    Returns:
    
    a Map of the node's current attachments
  - getAttachments
```
java.util.List<IAttachment> getAttachments(java.lang.Class<?> clazz)
```
    Returns a List of the node's attachments that are of the supplied type.
    
    Parameters:
    
    clazz - the attachment class type to retrieve
    
    Returns:
    
    a List of the node's attachments of the specified type.
  - getProperties
```
java.util.Map<java.lang.String,java.lang.Object> getProperties()
```
    Returns a Map of the node's current properties.
    
    Returns:
    
    a Map of the node's current properties.
  - getProperty
```
java.lang.Object getProperty(java.lang.String key)
```
    Returns the node property of the specified type or null if the property doesn't exist.
    
    Returns:
    
    the node property of the specified type or null if the property doesn't exist
  - setProperty
```
void setProperty(java.lang.String key,
                 java.lang.Object value)
```
    Sets the property identified by the key String to the supplied value.
    
    Parameters:
    
    key - the String identifier of the property
    
    value - the value of the property
  - hasProperty
```
boolean hasProperty(java.lang.String key)
```
    Returns true if the property has been set on this object, false otherwise.
    
    Parameters:
    
    key - the property key to check for
    
    Returns:
    
    true if the property exists, false otherwise

Interface INode

Field Summary

Method Summary

Field Detail

RENDERER_NODE_PROP

Method Detail

getParent

setParent

getName

addChild

removeChild

removeAllChildren

getChildren

setVisible

isVisible

attach

detach

hasAttachment

supports

getAttachments

getAttachments

getProperties

getProperty

setProperty

hasProperty