UniObject (Pure2D Game Engine)

java.lang.Object
- com.funzio.pure2D.uni.UniObject

All Implemented Interfaces:

Displayable, InvalidateFlags, Manipulatable, StackableObject

Direct Known Subclasses:

UniRect
```
public abstract class UniObject
extends java.lang.Object
implements StackableObject, InvalidateFlags
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`mAlive`
`protected float`	`mAlpha`
`protected boolean`	`mAutoUpdateBounds`
`protected GLColor`	`mBlendColor`
`protected BlendFunc`	`mBlendFunc`
`protected RectF`	`mBounds`
`protected boolean`	`mBypassCameraClipping`
`protected GLColor`	`mColor`
`protected int`	`mDebugFlags`
`protected float`	`mFrameDuration`
`protected PointF`	`mGlobalPosition`
`protected boolean`	`mHasOrigin`
`protected java.lang.String`	`mId`
`protected int`	`mInvalidateFlags`
`protected java.util.ArrayList<Manipulator>`	`mManipulators`
`protected Matrix`	`mMatrix`
`protected Matrix`	`mMatrixForVertices`
`protected int`	`mNumManipulators`
`protected PointF`	`mOrigin`
`protected boolean`	`mOriginAtCenter`
`protected UniContainer`	`mParent`
`protected PointF`	`mPivot`
`protected PointF`	`mPosition`
`protected float`	`mRotation`
`protected PointF`	`mScale`
`protected Scene`	`mScene`
`protected PointF`	`mSize`
`protected PointF`	`mSkew`
`protected boolean`	`mStackable`
`protected float[]`	`mVertices`
`protected boolean`	`mVisible`
`protected float`	`mZ`
`static java.lang.String`	`TAG`

Fields inherited from interface com.funzio.pure2D.Displayable
FLIP_X, FLIP_Y

Fields inherited from interface com.funzio.pure2D.InvalidateFlags
ALL, ALPHA, BLEND, BOUNDS, CACHE, CHILDREN, COLOR, DEPTH, FRAME, ORIGIN, PARENT, PARENT_BOUNDS, PERSPECTIVE, PIVOT, POSITION, ROTATION, SCALE, SIZE, SKEW, TEXTURE, TEXTURE_COORDS, TRANSFORM_MATRIX, VERTICES, VISIBILITY, VISUAL

Constructor Summary

Constructors
Constructor and Description

UniObject()

Constructors
Constructor and Description
`UniObject()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addManipulator(Manipulator manipulator)`
`void`	`dispose()`
`protected void`	`drawBounds(GLState glState)`
`protected void`	`drawWireframe(GLState glState)`
`float`	`getAlpha()`
`BlendFunc`	`getBlendFunc()`
`RectF`	`getBounds()` Get the Global Bounds of this object that takes translation, rotation and scale factors into account.
`GLColor`	`getColor()`
`int`	`getDebugFlags()`
`int`	`getFps()`
`PointF`	`getGlobalPosition()` Get global position of this object
`float`	`getHeight()`
`java.lang.String`	`getId()` for ui
`BlendFunc`	`getInheritedBlendFunc()`
`GLColor`	`getInheritedColor()`
`Manipulator`	`getManipulator(int index)`
`Matrix`	`getMatrix()`
`int`	`getNumManipulators()`
`int`	`getNumStackedChildren()`
`java.lang.String`	`getObjectTree(java.lang.String prefix)` for debugging
`PointF`	`getOrigin()`
`Parentable`	`getParent()`
`PointF`	`getPivot()`
`PointF`	`getPosition()`
`float`	`getRotation()`
`PointF`	`getScale()`
`Scene`	`getScene()`
`PointF`	`getSize()`
`PointF`	`getSkew()`
`float`	`getWidth()`
`float`	`getX()`
`float`	`getY()`
`float`	`getZ()`
`void`	`globalToLocal(PointF global, PointF result)` Converts a global point to a local point, without allocating new PointF
`void`	`invalidate()`
`void`	`invalidate(int flags)`
`boolean`	`isAlive()`
`boolean`	`isAutoUpdateBounds()`
`boolean`	`isBypassCameraClipping()`
`boolean`	`isOriginAtCenter()`
`boolean`	`isStackable()`
`boolean`	`isVisible()`
`void`	`localToGlobal(PointF local, PointF result)` Converts a local point to a global point, without allocating new PointF
`void`	`move(float dx, float dy)`
`void`	`moveTo(float x, float y)`
`void`	`onAdded(UniContainer container)` This is called after this object is added to a Container
`void`	`onAddedToScene(Scene scene)`
`void`	`onRemoved()` This is called after this object is removed from a Container
`void`	`onRemovedFromScene()`
`boolean`	`queueEvent(java.lang.Runnable r)`
`int`	`removeAllManipulators()`
`boolean`	`removeFromParent()`
`boolean`	`removeManipulator(Manipulator manipulator)`
`protected abstract void`	`resetVertices()`
`void`	`rotate(float degreeDelta)`
`void`	`setAlive(boolean value)` Toggles the heart-beat.
`void`	`setAlpha(float alpha)`
`void`	`setAutoUpdateBounds(boolean autoUpdateBounds)` This needs to be set to true if using Camera clipping.
`void`	`setBlendFunc(BlendFunc blendFunc)`
`void`	`setBypassCameraClipping(boolean ignoreCameraClipping)`
`void`	`setColor(GLColor color)`
`void`	`setDebugFlags(int flags)`
`void`	`setFps(int fps)`
`void`	`setId(java.lang.String id)`
`void`	`setOrigin(float x, float y)`
`void`	`setOrigin(PointF origin)`
`void`	`setOriginAtCenter()`
`void`	`setPivot(float x, float y)`
`void`	`setPivot(PointF pivot)`
`void`	`setPivotAtCenter()`
`void`	`setPosition(float x, float y)`
`void`	`setPosition(PointF position)`
`void`	`setRotation(float degree)`
`void`	`setScale(float scale)`
`void`	`setScale(float sx, float sy)`
`void`	`setSize(float w, float h)`
`void`	`setSize(PointF size)`
`void`	`setSkew(float kx, float ky)`
`void`	`setStackable(boolean value)`
`void`	`setVisible(boolean value)`
`void`	`setX(float x)`
`void`	`setY(float y)`
`void`	`setZ(float z)` Set the Z-depth
`boolean`	`shouldDraw(RectF globalViewRect)`
`boolean`	`update(int deltaTime)`
`RectF`	`updateBounds()`
`protected void`	`updateMatrix()` Find the global bounds of this object that takes position, scale, rotation, skew...
`protected void`	`validate(int flags)`

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

Methods inherited from interface com.funzio.pure2D.StackableObject
stack

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
  - mDebugFlags
```
protected int mDebugFlags
```
  - mId
```
protected java.lang.String mId
```
  - mPosition
```
protected PointF mPosition
```
  - mOrigin
```
protected PointF mOrigin
```
  - mSize
```
protected PointF mSize
```
  - mScale
```
protected PointF mScale
```
  - mPivot
```
protected PointF mPivot
```
  - mRotation
```
protected float mRotation
```
  - mZ
```
protected float mZ
```
  - mSkew
```
protected PointF mSkew
```
  - mAlive
```
protected boolean mAlive
```
  - mVisible
```
protected boolean mVisible
```
  - mFrameDuration
```
protected float mFrameDuration
```
  - mParent
```
protected UniContainer mParent
```
  - mScene
```
protected Scene mScene
```
  - mColor
```
protected GLColor mColor
```
  - mBlendColor
```
protected GLColor mBlendColor
```
  - mBlendFunc
```
protected BlendFunc mBlendFunc
```
  - mAlpha
```
protected float mAlpha
```
  - mHasOrigin
```
protected boolean mHasOrigin
```
  - mOriginAtCenter
```
protected boolean mOriginAtCenter
```
  - mManipulators
```
protected java.util.ArrayList<Manipulator> mManipulators
```
  - mNumManipulators
```
protected int mNumManipulators
```
  - mInvalidateFlags
```
protected int mInvalidateFlags
```
  - mMatrix
```
protected Matrix mMatrix
```
  - mMatrixForVertices
```
protected Matrix mMatrixForVertices
```
  - mBounds
```
protected RectF mBounds
```
  - mAutoUpdateBounds
```
protected boolean mAutoUpdateBounds
```
  - mBypassCameraClipping
```
protected boolean mBypassCameraClipping
```
  - mGlobalPosition
```
protected PointF mGlobalPosition
```
  - mVertices
```
protected float[] mVertices
```
  - mStackable
```
protected boolean mStackable
```
- Constructor Detail
  - UniObject
```
public UniObject()
```
- Method Detail
  - resetVertices
```
protected abstract void resetVertices()
```
  - drawWireframe
```
protected void drawWireframe(GLState glState)
```
  - drawBounds
```
protected void drawBounds(GLState glState)
```
  - update
```
public boolean update(int deltaTime)
```
    Specified by:
    
    update in interface Displayable
  - invalidate
```
public final void invalidate()
```
    Specified by:
    
    invalidate in interface Displayable
  - invalidate
```
public final void invalidate(int flags)
```
    Specified by:
    
    invalidate in interface Displayable
  - validate
```
protected final void validate(int flags)
```
  - setAlive
```
public void setAlive(boolean value)
```
    Toggles the heart-beat. If set to false, the update() does NOT get called. This can be used for optimization.
    
    Specified by:
    
    setAlive in interface Displayable
    
    See Also:
    update(int)
  - isAlive
```
public final boolean isAlive()
```
    Specified by:
    
    isAlive in interface Displayable
  - setVisible
```
public void setVisible(boolean value)
```
    Specified by:
    
    setVisible in interface Displayable
  - isVisible
```
public final boolean isVisible()
```
    Specified by:
    
    isVisible in interface Displayable
  - shouldDraw
```
public boolean shouldDraw(RectF globalViewRect)
```
    Specified by:
    
    shouldDraw in interface Displayable
  - setStackable
```
public void setStackable(boolean value)
```
    Specified by:
    
    setStackable in interface StackableObject
  - isStackable
```
public boolean isStackable()
```
    Specified by:
    
    isStackable in interface StackableObject
  - getPosition
```
public final PointF getPosition()
```
    Specified by:
    
    getPosition in interface Manipulatable
    
    Returns:
    the position
  - setPosition
```
public final void setPosition(PointF position)
```
    Specified by:
    
    setPosition in interface Manipulatable
    
    Parameters:
    position - the position to set
  - setPosition
```
public void setPosition(float x,
               float y)
```
    Specified by:
    
    setPosition in interface Manipulatable
    
    Parameters:
    position - the position to set
  - setX
```
public void setX(float x)
```
    Specified by:
    
    setX in interface Manipulatable
  - getX
```
public final float getX()
```
    Specified by:
    
    getX in interface Manipulatable
  - setY
```
public void setY(float y)
```
    Specified by:
    
    setY in interface Manipulatable
  - getY
```
public final float getY()
```
    Specified by:
    
    getY in interface Manipulatable
  - setZ
```
public void setZ(float z)
```
    Set the Z-depth
    
    Specified by:
    
    setZ in interface Displayable
    
    See Also:
    #setAlphaTestEnabled(boolean)
  - getZ
```
public final float getZ()
```
    Specified by:
    
    getZ in interface Displayable
  - moveTo
```
public void moveTo(float x,
          float y)
```
    Specified by:
    
    moveTo in interface Manipulatable
  - move
```
public void move(float dx,
        float dy)
```
    Specified by:
    
    move in interface Manipulatable
  - getOrigin
```
public final PointF getOrigin()
```
    Specified by:
    
    getOrigin in interface Displayable
    
    Returns:
    the origin
  - setOrigin
```
public final void setOrigin(PointF origin)
```
    Specified by:
    
    setOrigin in interface Displayable
    
    Parameters:
    origin - the origin to set. Origin is the local point and (0,0) by default. Origin is used to define offset of this object and also the center of rotation and scaling.
  - setOrigin
```
public void setOrigin(float x,
             float y)
```
    Specified by:
    
    setOrigin in interface Displayable
  - setOriginAtCenter
```
public void setOriginAtCenter()
```
    Specified by:
    
    setOriginAtCenter in interface Displayable
  - isOriginAtCenter
```
public boolean isOriginAtCenter()
```
  - getPivot
```
public PointF getPivot()
```
    Specified by:
    
    getPivot in interface Displayable
  - setPivot
```
public void setPivot(PointF pivot)
```
    Specified by:
    
    setPivot in interface Displayable
  - setPivot
```
public void setPivot(float x,
            float y)
```
    Specified by:
    
    setPivot in interface Displayable
  - setPivotAtCenter
```
public void setPivotAtCenter()
```
    Specified by:
    
    setPivotAtCenter in interface Displayable
  - getSize
```
public final PointF getSize()
```
    Specified by:
    
    getSize in interface Manipulatable
    
    Returns:
    the size
  - getWidth
```
public final float getWidth()
```
    Specified by:
    
    getWidth in interface Manipulatable
  - getHeight
```
public final float getHeight()
```
    Specified by:
    
    getHeight in interface Manipulatable
  - setSize
```
public final void setSize(PointF size)
```
    Specified by:
    
    setSize in interface Manipulatable
    
    Parameters:
    size - the size to set
  - setSize
```
public void setSize(float w,
           float h)
```
    Specified by:
    
    setSize in interface Manipulatable
    
    Parameters:
    size - the size to set
  - setScale
```
public void setScale(float sx,
            float sy)
```
    Specified by:
    
    setScale in interface Manipulatable
    
    Parameters:
    screen_scale - the scale to set
  - setScale
```
public void setScale(float scale)
```
    Specified by:
    
    setScale in interface Manipulatable
    
    Parameters:
    scale - the scale to set
  - getScale
```
public final PointF getScale()
```
    Specified by:
    
    getScale in interface Manipulatable
  - setRotation
```
public void setRotation(float degree)
```
    Specified by:
    
    setRotation in interface Manipulatable
  - rotate
```
public void rotate(float degreeDelta)
```
    Specified by:
    
    rotate in interface Manipulatable
  - getRotation
```
public final float getRotation()
```
    Specified by:
    
    getRotation in interface Manipulatable
  - setSkew
```
public void setSkew(float kx,
           float ky)
```
    Specified by:
    
    setSkew in interface Displayable
  - getSkew
```
public PointF getSkew()
```
    Specified by:
    
    getSkew in interface Displayable
  - getColor
```
public final GLColor getColor()
```
    Specified by:
    
    getColor in interface Displayable
    
    Returns:
    the color
  - setColor
```
public void setColor(GLColor color)
```
    Specified by:
    
    setColor in interface Displayable
    
    Parameters:
    color - the color to set
  - getBlendFunc
```
public BlendFunc getBlendFunc()
```
    Specified by:
    
    getBlendFunc in interface Displayable
    
    Returns:
    the blendFunc
  - setBlendFunc
```
public void setBlendFunc(BlendFunc blendFunc)
```
    Specified by:
    
    setBlendFunc in interface Displayable
    
    Parameters:
    blendFunc - the blendFunc to set
  - getInheritedColor
```
public final GLColor getInheritedColor()
```
    Specified by:
    
    getInheritedColor in interface Displayable
    
    Returns:
    the final color which takes parent's color and alpha into account
  - getInheritedBlendFunc
```
public final BlendFunc getInheritedBlendFunc()
```
    Specified by:
    
    getInheritedBlendFunc in interface Displayable
  - getAlpha
```
public final float getAlpha()
```
    Specified by:
    
    getAlpha in interface Displayable
    
    Returns:
    the alpha
  - setAlpha
```
public void setAlpha(float alpha)
```
    Specified by:
    
    setAlpha in interface Displayable
    
    Parameters:
    alpha - the alpha to set
  - getFps
```
public final int getFps()
```
    Specified by:
    
    getFps in interface Displayable
    
    Returns:
    the fps
  - setFps
```
public void setFps(int fps)
```
    Specified by:
    
    setFps in interface Displayable
    
    Parameters:
    fps - the fps to set
  - addManipulator
```
public boolean addManipulator(Manipulator manipulator)
```
    Specified by:
    
    addManipulator in interface Displayable
  - removeManipulator
```
public boolean removeManipulator(Manipulator manipulator)
```
    Specified by:
    
    removeManipulator in interface Displayable
  - removeAllManipulators
```
public int removeAllManipulators()
```
    Specified by:
    
    removeAllManipulators in interface Displayable
  - getManipulator
```
public Manipulator getManipulator(int index)
```
    Specified by:
    
    getManipulator in interface Displayable
  - getNumManipulators
```
public int getNumManipulators()
```
    Specified by:
    
    getNumManipulators in interface Displayable
  - getParent
```
public final Parentable getParent()
```
    Specified by:
    
    getParent in interface Displayable
  - queueEvent
```
public final boolean queueEvent(java.lang.Runnable r)
```
    Specified by:
    
    queueEvent in interface Displayable
  - removeFromParent
```
public boolean removeFromParent()
```
    Specified by:
    
    removeFromParent in interface Displayable
  - localToGlobal
```
public final void localToGlobal(PointF local,
                 PointF result)
```
    Converts a local point to a global point, without allocating new PointF
    
    Specified by:
    
    localToGlobal in interface Displayable
    
    Parameters:
    local -
    result -
  - globalToLocal
```
public final void globalToLocal(PointF global,
                 PointF result)
```
    Converts a global point to a local point, without allocating new PointF
    
    Specified by:
    
    globalToLocal in interface Displayable
    
    Parameters:
    global -
    result -
  - updateMatrix
```
protected void updateMatrix()
```
    Find the global bounds of this object that takes position, scale, rotation, skew... into account. Used mainly for Camera clipping and bounds hit-testing.
  - getGlobalPosition
```
public PointF getGlobalPosition()
```
    Get global position of this object
    
    Returns:
    the global point
  - updateBounds
```
public RectF updateBounds()
```
    Specified by:
    
    updateBounds in interface Displayable
  - getMatrix
```
public final Matrix getMatrix()
```
  - getBounds
```
public final RectF getBounds()
```
    Get the Global Bounds of this object that takes translation, rotation and scale factors into account.
    
    Specified by:
    
    getBounds in interface Displayable
    
    Specified by:
    
    getBounds in interface Manipulatable
    
    Returns:
  - isAutoUpdateBounds
```
public final boolean isAutoUpdateBounds()
```
    Specified by:
    
    isAutoUpdateBounds in interface Displayable
    
    Returns:
    the autoUpdateBounds
  - isBypassCameraClipping
```
public boolean isBypassCameraClipping()
```
  - setBypassCameraClipping
```
public void setBypassCameraClipping(boolean ignoreCameraClipping)
```
  - setAutoUpdateBounds
```
public void setAutoUpdateBounds(boolean autoUpdateBounds)
```
    This needs to be set to true if using Camera clipping.
    
    Specified by:
    
    setAutoUpdateBounds in interface Displayable
    
    Parameters:
    autoUpdateBounds - the autoUpdateBounds to set
  - getNumStackedChildren
```
public int getNumStackedChildren()
```
    Specified by:
    
    getNumStackedChildren in interface StackableObject
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface Displayable
  - getDebugFlags
```
public int getDebugFlags()
```
    Returns:
    See Also:
    Pure2D.DEBUG_FLAG_LOCAL_SHAPE, Pure2D.DEBUG_FLAG_GLOBAL_BOUNDS
  - setDebugFlags
```
public void setDebugFlags(int flags)
```
    Parameters:
    flags -
    See Also:
    Pure2D.DEBUG_FLAG_SHAPE, Pure2D.DEBUG_FLAG_BOUNDS
  - getObjectTree
```
public java.lang.String getObjectTree(java.lang.String prefix)
```
    for debugging
    
    Specified by:
    
    getObjectTree in interface Displayable
  - getId
```
public java.lang.String getId()
```
    for ui
    
    Specified by:
    
    getId in interface Displayable
  - setId
```
public void setId(java.lang.String id)
```
    Specified by:
    
    setId in interface Displayable
  - getScene
```
public Scene getScene()
```
    Specified by:
    
    getScene in interface Displayable
  - onAdded
```
public void onAdded(UniContainer container)
```
    This is called after this object is added to a Container
    
    Specified by:
    
    onAdded in interface StackableObject
  - onRemoved
```
public void onRemoved()
```
    This is called after this object is removed from a Container
    
    Specified by:
    
    onRemoved in interface Displayable
  - onAddedToScene
```
public void onAddedToScene(Scene scene)
```
    Specified by:
    
    onAddedToScene in interface Displayable
  - onRemovedFromScene
```
public void onRemovedFromScene()
```
    Specified by:
    
    onRemovedFromScene in interface Displayable

Class UniObject

Field Summary

Fields inherited from interface com.funzio.pure2D.Displayable

Fields inherited from interface com.funzio.pure2D.InvalidateFlags

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.funzio.pure2D.StackableObject

Field Detail

TAG

mDebugFlags

mId

mPosition

mOrigin

mSize

mScale

mPivot

mRotation

mZ

mSkew

mAlive

mVisible

mFrameDuration

mParent

mScene

mColor

mBlendColor

mBlendFunc

mAlpha

mHasOrigin

mOriginAtCenter

mManipulators

mNumManipulators

mInvalidateFlags

mMatrix

mMatrixForVertices

mBounds

mAutoUpdateBounds

mBypassCameraClipping

mGlobalPosition

mVertices

mStackable

Constructor Detail

UniObject

Method Detail

resetVertices

drawWireframe

drawBounds

update

invalidate

invalidate

validate

setAlive

isAlive

setVisible

isVisible

shouldDraw

setStackable

isStackable

getPosition

setPosition

setPosition

setX

getX

setY

getY

setZ

getZ

moveTo

move

getOrigin

setOrigin

setOrigin

setOriginAtCenter

isOriginAtCenter

getPivot

setPivot

setPivot

setPivotAtCenter

getSize