MrObject

java.lang.Object
- mr.robotto.sceneobjects.MrObject

Direct Known Subclasses:

MrCamera, MrLight, MrModel, MrScene
```
public abstract class MrObject
extends java.lang.Object
```
Base class for MrRobotto Object hierarchy. This class provides access to the user to control an object.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MrObject.MrObjectBuilder
Builder base class for MrObject creation

Nested Classes
Modifier and Type	Class and Description
`static class`	`MrObject.MrObjectBuilder` Builder base class for MrObject creation

Constructor Summary

Constructors
Modifier Constructor and Description

protected MrObject(MrObjectController controller)
Creates an MrObject using a controller

Constructors
Modifier	Constructor and Description
`protected`	`MrObject(MrObjectController controller)` Creates an MrObject using a controller

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addChild(MrObject data)`
`java.util.Iterator<MrObject>`	`breadthTraversal()`
`java.util.Iterator<MrObject>`	`depthTraversal()`
`MrObject`	`findChild(java.lang.String key)`
`java.util.List<MrObject>`	`getByType(MrSceneObjectType type)`
`java.util.List<MrObject>`	`getChildren()`
`MrObjectController`	`getController()` Gets the object controller of this object
`MrEventsListener`	`getEventsListener()` Gets the current event listener
`MrVector3f`	`getForward()` Gets the positive Y axis of this object local axis in world coordinates
`MrVector3f`	`getLocation()` Gets the location of this object
`java.lang.String`	`getName()` Gets the name of this object
`MrObject`	`getParent()`
`java.util.Set<java.lang.String>`	`getRegisteredEvents()` Gets a set of all registered events
`MrVector3f`	`getRight()` Gets the positive X axis of this object local axis in world coordinates
`MrRobottoEngine`	`getRobottoEngine()` Gets the reference to the engine used.
`MrObject`	`getRoot()`
`MrQuaternion`	`getRotation()` Gets the rotation quaternion
`MrVector3f`	`getScale()` Gets the scale vector of this object
`MrSceneObjectType`	`getSceneObjectType()` Gets the type of this object
`MrShaderProgram`	`getShaderProgram()` Gets the current shader program, if the object has any
`MrTransform`	`getTransform()` Gets the transformation object of this object
`MrSceneTree`	`getTree()` Gets the SceneTree which this objects belongs to
`java.util.Map<java.lang.String,MrUniformGenerator>`	`getUniformGenerators()` Gets the uniform generators associated to this object
`java.util.Map<java.lang.String,MrUniformKey>`	`getUniformKeys()` Gets the uniform keys provided by this object
`MrVector3f`	`getUp()` Gets the positive Z axis of this object local axis in world coordinates
`void`	`initializeUniforms(java.util.Map<java.lang.String,MrUniformGenerator> uniformGenerators)` Call this method if you want to create a new uniform generator for this object
`boolean`	`isChild(MrObject data)`
`boolean`	`isChild(java.lang.String key)`
`boolean`	`isEventRegistered(java.lang.String evName)` Checks if the event is register in the event listener of this object
`boolean`	`isInitialized()` Checks if initialize has been called on this object
`java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>>`	`parentKeyChildValueTraversal()`
`java.util.Iterator<MrObject>`	`parentTraversal()`
`protected void`	`queueEvent(java.lang.Runnable runnable)` Queues a runnable.
`void`	`registerEvent(java.lang.String eventName)` Registers an event
`boolean`	`removeChild(MrObject data)`
`void`	`rotate(float angle, float x, float y, float z)` Rotates this object by the given angle around the given axis
`void`	`rotate(float angle, MrVector3f axis)` Rotates the object by a certain angle around the given axis
`void`	`rotate(MrQuaternion q)` Rotates this object by the given rotation
`void`	`rotateAround(float angle, MrVector3f point, MrVector3f axis)` Rotates this object by the given angle, around the given axis, located at the given point
`void`	`rotateAround(float angle, MrVector3f point, MrVector3f axis, MrVector3f through)` Rotates this object by the given angle, around the given axis and passing through the given point
`void`	`scale(float s)` Scales the object in all axis
`void`	`scale(float sx, float sy, float sz)` Scales every axis by given values
`void`	`scale(MrVector3f s)` Scales every axis by given values
`void`	`setEventsListener(MrEventsListener eventsListener)` Sets a new event listener
`void`	`setLocation(float x, float y, float z)` Sets the location of this object.
`void`	`setLocation(MrVector3f location)` Sets the location of this object.
`void`	`setLookAt(MrVector3f look)` Sets where this object will point to.
`void`	`setLookAt(MrVector3f look, MrVector3f up)` Points this object to look with the given up vector
`void`	`setRobottoEngine(MrRobottoEngine robotto)` Sets the reference to the engine.
`void`	`setRotation(float angle, float x, float y, float z)` Sets the rotation of this object.
`void`	`setRotation(float angle, MrVector3f axis)` Sets the rotation of this object.
`void`	`setRotation(MrQuaternion rotation)` Sets the rotation of this object using a quaternion
`void`	`setScale(float sx, float sy, float sz)` Sets the scale of this object.
`void`	`setScale(MrVector3f scale)` Sets the scale of this object.
`void`	`setTransform(MrTransform transform)` Sets a new transform for this object
`void`	`setTree(MrSceneTree tree)`
`java.lang.String`	`toString()`
`void`	`translate(float x, float y, float z)` Translates an object by x, y, z for every axis in world coordinates
`void`	`translate(MrVector3f v)` Translates an object by the given vector in world coordinates
`void`	`unregisterEvent(java.lang.String eventName)` Unregisters an event

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MrObject
```
protected MrObject(MrObjectController controller)
```
    Creates an MrObject using a controller
    
    Parameters:
    
    controller - controller for this object
- Method Detail
  - getController
```
public MrObjectController getController()
```
    Gets the object controller of this object
    
    Returns:
    
    The controller
  - getRobottoEngine
```
public MrRobottoEngine getRobottoEngine()
```
    Gets the reference to the engine used.
    
    Returns:
    
    gets the RobottoEngine instance this object is attached to
  - setRobottoEngine
```
public void setRobottoEngine(MrRobottoEngine robotto)
```
    Sets the reference to the engine. This method should not be called directly by the user
    
    Parameters:
    
    robotto - the engine which contains this object
  - queueEvent
```
protected void queueEvent(java.lang.Runnable runnable)
```
    Queues a runnable. Use when calling methods from the UI-Thread
    
    Parameters:
    
    runnable - runnable to be executed
  - initializeUniforms
```
public void initializeUniforms(java.util.Map<java.lang.String,MrUniformGenerator> uniformGenerators)
```
    Call this method if you want to create a new uniform generator for this object
    
    Parameters:
    
    uniformGenerators - uniform generator map to add new generators
  - getSceneObjectType
```
public MrSceneObjectType getSceneObjectType()
```
    Gets the type of this object
    
    Returns:
  - isInitialized
```
public boolean isInitialized()
```
    Checks if initialize has been called on this object
    
    Returns:
    
    true if the object is initialized, false otherwise
  - getName
```
public java.lang.String getName()
```
    Gets the name of this object
    
    Returns:
  - getTransform
```
public MrTransform getTransform()
```
    Gets the transformation object of this object
    
    Returns:
  - setTransform
```
public void setTransform(MrTransform transform)
```
    Sets a new transform for this object
    
    Parameters:
    
    transform -
  - getUniformGenerators
```
public java.util.Map<java.lang.String,MrUniformGenerator> getUniformGenerators()
```
    Gets the uniform generators associated to this object
    
    Returns:
    
    a map containing generator name - generator items
  - getShaderProgram
```
public MrShaderProgram getShaderProgram()
```
    Gets the current shader program, if the object has any
    
    Returns:
  - getUniformKeys
```
public java.util.Map<java.lang.String,MrUniformKey> getUniformKeys()
```
    Gets the uniform keys provided by this object
    
    Returns:
    
    a map containing uniform key type - uniform key items
  - getTree
```
public MrSceneTree getTree()
```
    Gets the SceneTree which this objects belongs to
    
    Returns:
  - setTree
```
public void setTree(MrSceneTree tree)
```
  - addChild
```
public boolean addChild(MrObject data)
```
  - removeChild
```
public boolean removeChild(MrObject data)
```
  - getByType
```
public java.util.List<MrObject> getByType(MrSceneObjectType type)
```
  - getRoot
```
public MrObject getRoot()
```
  - findChild
```
public MrObject findChild(java.lang.String key)
```
  - isChild
```
public boolean isChild(MrObject data)
```
  - isChild
```
public boolean isChild(java.lang.String key)
```
  - getParent
```
public MrObject getParent()
```
  - getChildren
```
public java.util.List<MrObject> getChildren()
```
  - parentTraversal
```
public java.util.Iterator<MrObject> parentTraversal()
```
  - breadthTraversal
```
public java.util.Iterator<MrObject> breadthTraversal()
```
  - depthTraversal
```
public java.util.Iterator<MrObject> depthTraversal()
```
  - parentKeyChildValueTraversal
```
public java.util.Iterator<java.util.Map.Entry<java.lang.String,MrObject>> parentKeyChildValueTraversal()
```
  - getEventsListener
```
public MrEventsListener getEventsListener()
```
    Gets the current event listener
    
    Returns:
  - setEventsListener
```
public void setEventsListener(MrEventsListener eventsListener)
```
    Sets a new event listener
    
    Parameters:
    
    eventsListener -
  - isEventRegistered
```
public boolean isEventRegistered(java.lang.String evName)
```
    Checks if the event is register in the event listener of this object
    
    Parameters:
    
    evName - event name
    
    Returns:
  - getRegisteredEvents
```
public java.util.Set<java.lang.String> getRegisteredEvents()
```
    Gets a set of all registered events
    
    Returns:
  - registerEvent
```
public void registerEvent(java.lang.String eventName)
```
    Registers an event
    
    Parameters:
    
    eventName -
  - unregisterEvent
```
public void unregisterEvent(java.lang.String eventName)
```
    Unregisters an event
    
    Parameters:
    
    eventName -
  - getRotation
```
public MrQuaternion getRotation()
```
    Gets the rotation quaternion
    
    Returns:
  - setRotation
```
public void setRotation(MrQuaternion rotation)
```
    Sets the rotation of this object using a quaternion
    
    Parameters:
    
    rotation -
  - rotate
```
public void rotate(float angle,
                   MrVector3f axis)
```
    Rotates the object by a certain angle around the given axis
    
    Parameters:
    
    angle - angle of rotation in degrees
    
    axis - axis in world coordinates
  - translate
```
public void translate(float x,
                      float y,
                      float z)
```
    Translates an object by x, y, z for every axis in world coordinates
    
    Parameters:
    
    x - translation in x
    
    y - translation in y
    
    z - translation in z
  - scale
```
public void scale(float s)
```
    Scales the object in all axis
    
    Parameters:
    
    s - scale factor
  - scale
```
public void scale(MrVector3f s)
```
    Scales every axis by given values
    
    Parameters:
    
    s - scale vector
  - getRight
```
public MrVector3f getRight()
```
    Gets the positive X axis of this object local axis in world coordinates
    
    Returns:
  - setLookAt
```
public void setLookAt(MrVector3f look,
                      MrVector3f up)
```
    Points this object to look with the given up vector
    
    Parameters:
    
    look -
    
    up -
  - scale
```
public void scale(float sx,
                  float sy,
                  float sz)
```
    Scales every axis by given values
    
    Parameters:
    
    sx - scale in X axis
    
    sy - scale in Y axis
    
    sz - scale in Z axis
  - setScale
```
public void setScale(float sx,
                     float sy,
                     float sz)
```
    Sets the scale of this object. This method operates in place
    
    Parameters:
    
    sx -
    
    sy -
    
    sz -
  - translate
```
public void translate(MrVector3f v)
```
    Translates an object by the given vector in world coordinates
    
    Parameters:
    
    v -
  - getForward
```
public MrVector3f getForward()
```
    Gets the positive Y axis of this object local axis in world coordinates
    
    Returns:
  - getScale
```
public MrVector3f getScale()
```
    Gets the scale vector of this object
    
    Returns:
  - setScale
```
public void setScale(MrVector3f scale)
```
    Sets the scale of this object. This method operates in place
    
    Parameters:
    
    scale -
  - setLocation
```
public void setLocation(float x,
                        float y,
                        float z)
```
    Sets the location of this object. This method operates in place
    
    Parameters:
    
    x -
    
    y -
    
    z -
  - setRotation
```
public void setRotation(float angle,
                        MrVector3f axis)
```
    Sets the rotation of this object. This method operates in place
    
    Parameters:
    
    angle - angle of rotation in degrees
    
    axis - axis to rotate around in world coordinates
  - getUp
```
public MrVector3f getUp()
```
    Gets the positive Z axis of this object local axis in world coordinates
    
    Returns:
  - setLookAt
```
public void setLookAt(MrVector3f look)
```
    Sets where this object will point to. This method operates in place
    
    Parameters:
    
    look -
  - setRotation
```
public void setRotation(float angle,
                        float x,
                        float y,
                        float z)
```
    Sets the rotation of this object. This method operates in place
    
    Parameters:
    
    angle - angle of rotation in degrees
    
    x -
    
    y -
    
    z -
  - getLocation
```
public MrVector3f getLocation()
```
    Gets the location of this object
    
    Returns:
  - setLocation
```
public void setLocation(MrVector3f location)
```
    Sets the location of this object. This method operates in place
    
    Parameters:
    
    location -
  - rotateAround
```
public void rotateAround(float angle,
                         MrVector3f point,
                         MrVector3f axis)
```
    Rotates this object by the given angle, around the given axis, located at the given point
    
    Parameters:
    
    angle - angle of rotation in degrees
    
    point - point where the object will be located
    
    axis - axis of rotation in world coordinates
  - rotate
```
public void rotate(MrQuaternion q)
```
    Rotates this object by the given rotation
    
    Parameters:
    
    q -
  - rotateAround
```
public void rotateAround(float angle,
                         MrVector3f point,
                         MrVector3f axis,
                         MrVector3f through)
```
    Rotates this object by the given angle, around the given axis and passing through the given point
    
    Parameters:
    
    angle - angle of rotation in degrees
    
    point - point where the object will be located
    
    axis - axis of rotation in world coordinates
    
    through - point to pass through when rotates in world coordinates
  - rotate
```
public void rotate(float angle,
                   float x,
                   float y,
                   float z)
```
    Rotates this object by the given angle around the given axis
    
    Parameters:
    
    angle -
    
    x -
    
    y -
    
    z -
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MrObject

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MrObject

Method Detail

getController

getRobottoEngine

setRobottoEngine

queueEvent

initializeUniforms

getSceneObjectType

isInitialized

getName

getTransform

setTransform

getUniformGenerators

getShaderProgram

getUniformKeys

getTree

setTree

addChild

removeChild

getByType

getRoot

findChild

isChild

isChild

getParent

getChildren

parentTraversal

breadthTraversal

depthTraversal

parentKeyChildValueTraversal

getEventsListener

setEventsListener

isEventRegistered

getRegisteredEvents

registerEvent

unregisterEvent

getRotation

setRotation

rotate

translate

scale

scale

getRight

setLookAt

scale

setScale

translate

getForward

getScale

setScale

setLocation

setRotation

getUp

setLookAt

setRotation

getLocation

setLocation

rotateAround

rotate

rotateAround

rotate

toString