MmgPositionTween

java.lang.Object
- net.middlemind.MmgGameApiJava.MmgBase.MmgObj
- - net.middlemind.MmgGameApiJava.MmgBase.MmgPositionTween

```
public class MmgPositionTween
extends MmgObj
```
Class that provides tween support to an underlying MmgObj instance. Created by Middlemind Games 12/01/2016

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MMG_POSITION_TWEEN_REACH_FINISH`
`static int`	`MMG_POSITION_TWEEN_REACH_FINISH_TYPE`
`static int`	`MMG_POSITION_TWEEN_REACH_START`
`static int`	`MMG_POSITION_TWEEN_REACH_START_TYPE`

Fields inherited from class net.middlemind.MmgGameApiJava.MmgBase.MmgObj
color, h, hasParent, isVisible, mmgUid, name, parent, pos, w

Constructor Summary

Constructors
Constructor and Description
`MmgPositionTween(float msTimeToMove, MmgVector2 startPos, MmgVector2 finishPos)`
`MmgPositionTween(MmgObj subj, float msTimeToMove, MmgVector2 startPos, MmgVector2 finishPos)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MmgObj`	`Clone()` Clones this class.
`boolean`	`Equals(MmgPositionTween r)`
`boolean`	`GetAtFinish()`
`boolean`	`GetAtStart()`
`boolean`	`GetDirStartToFinish()`
`MmgVector2`	`GetFinishPosition()`
`int`	`GetHeight()` Gets the height of this object.
`boolean`	`GetMoving()`
`long`	`GetMsStartMove()`
`float`	`GetMsTimeToMove()`
`MmgEventHandler`	`GetOnReachFinish()`
`MmgEventHandler`	`GetOnReachStart()`
`MmgVector2`	`GetPixelDistToMove()`
`float`	`GetPixelsPerMsToMoveX()`
`float`	`GetPixelsPerMsToMoveY()`
`MmgVector2`	`GetPosition()` Gets the position of this object.
`MmgVector2`	`GetStartPosition()`
`MmgObj`	`GetSubj()`
`int`	`GetWidth()` Gets the width of this object.
`void`	`MmgDraw(MmgPen p)` The base drawing method for the bitmap object.
`boolean`	`MmgUpdate(int updateTick, long currentTimeMs, long msSinceLastFrame)` Update the current sprite animation frame index.
`void`	`SetAtFinish(boolean b)`
`void`	`SetAtStart(boolean b)`
`void`	`SetDirStartToFinish(boolean b)`
`void`	`SetFinishEventId(int i)`
`void`	`SetFinishPosition(MmgVector2 v)`
`void`	`SetHeight(int h)` Sets the height of this object.
`void`	`SetMoving(boolean b)`
`void`	`SetMsStartMove(long l)`
`void`	`SetMsTimeToMove(float i)`
`void`	`SetOnReachFinish(MmgEventHandler o)`
`void`	`SetOnReachStart(MmgEventHandler o)`
`void`	`SetPixelDistToMove(MmgVector2 v)`
`void`	`SetPixelsPerMsToMoveX(float i)`
`void`	`SetPixelsPerMsToMoveY(float i)`
`void`	`SetPosition(MmgVector2 v)` Sets the position of this object.
`void`	`SetStartEventId(int i)`
`void`	`SetStartPosition(MmgVector2 v)`
`void`	`SetSubj(MmgObj b)`
`void`	`SetWidth(int w)` Sets the width of this object.

Methods inherited from class net.middlemind.MmgGameApiJava.MmgBase.MmgObj
Equals, GetHasParent, GetId, GetIsVisible, GetMmgColor, GetName, GetParent, GetVersion, GetX, GetY, SetHasParent, SetId, SetIsVisible, SetMmgColor, SetName, SetParent, SetX, SetY, ToString

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

Field Detail
- MMG_POSITION_TWEEN_REACH_FINISH
```
public static final int MMG_POSITION_TWEEN_REACH_FINISH
```
  See Also:
  
  Constant Field Values
- MMG_POSITION_TWEEN_REACH_START
```
public static final int MMG_POSITION_TWEEN_REACH_START
```
  See Also:
  
  Constant Field Values
- MMG_POSITION_TWEEN_REACH_FINISH_TYPE
```
public static final int MMG_POSITION_TWEEN_REACH_FINISH_TYPE
```
  See Also:
  
  Constant Field Values
- MMG_POSITION_TWEEN_REACH_START_TYPE
```
public static final int MMG_POSITION_TWEEN_REACH_START_TYPE
```
  See Also:
  
  Constant Field Values

Constructor Detail

MmgPositionTween

public MmgPositionTween(MmgObj subj,
                        float msTimeToMove,
                        MmgVector2 startPos,
                        MmgVector2 finishPos)

MmgPositionTween

public MmgPositionTween(float msTimeToMove,
                        MmgVector2 startPos,
                        MmgVector2 finishPos)

Method Detail
- SetFinishEventId
```
public void SetFinishEventId(int i)
```
- SetStartEventId
```
public void SetStartEventId(int i)
```
- GetOnReachFinish
```
public MmgEventHandler GetOnReachFinish()
```
- SetOnReachFinish
```
public void SetOnReachFinish(MmgEventHandler o)
```
- GetOnReachStart
```
public MmgEventHandler GetOnReachStart()
```
- SetOnReachStart
```
public void SetOnReachStart(MmgEventHandler o)
```
- GetMsStartMove
```
public long GetMsStartMove()
```
- SetMsStartMove
```
public void SetMsStartMove(long l)
```
- GetPixelsPerMsToMoveX
```
public float GetPixelsPerMsToMoveX()
```
- SetPixelsPerMsToMoveX
```
public void SetPixelsPerMsToMoveX(float i)
```
- GetPixelsPerMsToMoveY
```
public float GetPixelsPerMsToMoveY()
```
- SetPixelsPerMsToMoveY
```
public void SetPixelsPerMsToMoveY(float i)
```
- GetMoving
```
public boolean GetMoving()
```
- SetMoving
```
public void SetMoving(boolean b)
```
- GetDirStartToFinish
```
public boolean GetDirStartToFinish()
```
- SetDirStartToFinish
```
public void SetDirStartToFinish(boolean b)
```
- GetStartPosition
```
public MmgVector2 GetStartPosition()
```
- SetStartPosition
```
public void SetStartPosition(MmgVector2 v)
```
- GetFinishPosition
```
public MmgVector2 GetFinishPosition()
```
- SetFinishPosition
```
public void SetFinishPosition(MmgVector2 v)
```
- GetPixelDistToMove
```
public MmgVector2 GetPixelDistToMove()
```
- SetPixelDistToMove
```
public void SetPixelDistToMove(MmgVector2 v)
```
- GetMsTimeToMove
```
public float GetMsTimeToMove()
```
- SetMsTimeToMove
```
public void SetMsTimeToMove(float i)
```
- SetAtStart
```
public void SetAtStart(boolean b)
```
- GetAtStart
```
public boolean GetAtStart()
```
- SetAtFinish
```
public void SetAtFinish(boolean b)
```
- GetAtFinish
```
public boolean GetAtFinish()
```
- SetSubj
```
public void SetSubj(MmgObj b)
```
- GetSubj
```
public MmgObj GetSubj()
```
- Clone
```
public MmgObj Clone()
```
  Clones this class.
  
  Overrides:
  
  Clone in class MmgObj
  
  Returns:
  
  A clone of this class.
- MmgDraw
```
public void MmgDraw(MmgPen p)
```
  The base drawing method for the bitmap object.
  
  Overrides:
  
  MmgDraw in class MmgObj
  
  Parameters:
  
  p - The MmgPen used to draw this bitmap.
- MmgUpdate
```
public boolean MmgUpdate(int updateTick,
                         long currentTimeMs,
                         long msSinceLastFrame)
```
  Update the current sprite animation frame index.
  
  Overrides:
  
  MmgUpdate in class MmgObj
  
  Parameters:
  
  updateTick -
  
  currentTimeMs -
  
  msSinceLastFrame -
  
  Returns:
- GetWidth
```
public int GetWidth()
```
  Description copied from class: MmgObj
  
  Gets the width of this object.
  
  Overrides:
  
  GetWidth in class MmgObj
  
  Returns:
  
  The width of this object.
- SetWidth
```
public void SetWidth(int w)
```
  Description copied from class: MmgObj
  
  Sets the width of this object.
  
  Overrides:
  
  SetWidth in class MmgObj
  
  Parameters:
  
  w - The width of this object.
- GetHeight
```
public int GetHeight()
```
  Description copied from class: MmgObj
  
  Gets the height of this object.
  
  Overrides:
  
  GetHeight in class MmgObj
  
  Returns:
  
  The height of this object.
- SetHeight
```
public void SetHeight(int h)
```
  Description copied from class: MmgObj
  
  Sets the height of this object.
  
  Overrides:
  
  SetHeight in class MmgObj
  
  Parameters:
  
  h - The height of this object.
- GetPosition
```
public MmgVector2 GetPosition()
```
  Description copied from class: MmgObj
  
  Gets the position of this object.
  
  Overrides:
  
  GetPosition in class MmgObj
  
  Returns:
  
  The position of this object.
- SetPosition
```
public void SetPosition(MmgVector2 v)
```
  Description copied from class: MmgObj
  
  Sets the position of this object.
  
  Overrides:
  
  SetPosition in class MmgObj
  
  Parameters:
  
  v - The position of this object.
- Equals
```
public boolean Equals(MmgPositionTween r)
```

Class MmgPositionTween

Field Summary

Fields inherited from class net.middlemind.MmgGameApiJava.MmgBase.MmgObj

Constructor Summary

Method Summary

Methods inherited from class net.middlemind.MmgGameApiJava.MmgBase.MmgObj

Methods inherited from class java.lang.Object

Field Detail

MMG_POSITION_TWEEN_REACH_FINISH

MMG_POSITION_TWEEN_REACH_START

MMG_POSITION_TWEEN_REACH_FINISH_TYPE

MMG_POSITION_TWEEN_REACH_START_TYPE

Constructor Detail

MmgPositionTween

MmgPositionTween

Method Detail

SetFinishEventId

SetStartEventId

GetOnReachFinish

SetOnReachFinish

GetOnReachStart

SetOnReachStart

GetMsStartMove

SetMsStartMove

GetPixelsPerMsToMoveX

SetPixelsPerMsToMoveX

GetPixelsPerMsToMoveY

SetPixelsPerMsToMoveY

GetMoving

SetMoving

GetDirStartToFinish

SetDirStartToFinish

GetStartPosition

SetStartPosition

GetFinishPosition

SetFinishPosition

GetPixelDistToMove

SetPixelDistToMove

GetMsTimeToMove

SetMsTimeToMove

SetAtStart

GetAtStart

SetAtFinish

GetAtFinish

SetSubj

GetSubj

Clone

MmgDraw

MmgUpdate

GetWidth

SetWidth

GetHeight

SetHeight

GetPosition

SetPosition

Equals