Motion (core 1.0.4 API)

java.lang.Object
- androidx.constraintlayout.core.motion.Motion

All Implemented Interfaces:

TypedValues
```
public class Motion
extends java.lang.Object
implements TypedValues
```
This contains the picture of a view through the a transition and is used to interpolate it During an transition every view has a MotionController which drives its position.
All parameter which affect a views motion are added to MotionController and then setup() builds out the splines that control the view.

Nested Class Summary
- Nested classes/interfaces inherited from interface androidx.constraintlayout.core.motion.utils.TypedValues
  TypedValues.AttributesType, TypedValues.Custom, TypedValues.CycleType, TypedValues.MotionScene, TypedValues.MotionType, TypedValues.OnSwipe, TypedValues.PositionType, TypedValues.TransitionType, TypedValues.TriggerType

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DRAW_PATH_AS_CONFIGURED`
`static int`	`DRAW_PATH_BASIC`
`static int`	`DRAW_PATH_CARTESIAN`
`static int`	`DRAW_PATH_NONE`
`static int`	`DRAW_PATH_RECTANGLE`
`static int`	`DRAW_PATH_RELATIVE`
`static int`	`DRAW_PATH_SCREEN`
`static int`	`HORIZONTAL_PATH_X`
`static int`	`HORIZONTAL_PATH_Y`
`static int`	`PATH_PERCENT`
`static int`	`PATH_PERPENDICULAR`
`static int`	`ROTATION_LEFT`
`static int`	`ROTATION_RIGHT`
`static int`	`VERTICAL_PATH_X`
`static int`	`VERTICAL_PATH_Y`

Fields inherited from interface androidx.constraintlayout.core.motion.utils.TypedValues
BOOLEAN_MASK, FLOAT_MASK, INT_MASK, S_CUSTOM, STRING_MASK, TYPE_FRAME_POSITION, TYPE_TARGET

Constructor Summary

Constructors
Constructor and Description

Motion(MotionWidget view)

Constructors
Constructor and Description
`Motion(MotionWidget view)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addKey(MotionKey key)`
`int`	`buildKeyFrames(float[] keyFrames, int[] mode, int[] pos)`
`void`	`buildPath(float[] points, int pointCount)` fill the array point with the center coordinates point[0] is filled with the x coordinate of "time" 0.0 mPoints[point.length-1] is filled with the y coordinate of "time" 1.0
`void`	`buildRect(float p, float[] path, int offset)`
`int`	`getAnimateRelativeTo()` Will return the id of the view to move relative to The position at the start and then end will be viewed relative to this view -1 is the return value if NOT in polar mode
`void`	`getCenter(double p, float[] pos, float[] vel)`
`float`	`getCenterX()`
`float`	`getCenterY()`
`int`	`getDrawPath()`
`float`	`getFinalHeight()` get the width of the widget at the end of the movement.
`float`	`getFinalWidth()` get the width of the widget at the end of the movement.
`float`	`getFinalX()` get the left most position of the widget at the end of the movement.
`float`	`getFinalY()` get the top most position of the widget at the end of the movement.
`int`	`getId(java.lang.String name)`
`MotionPaths`	`getKeyFrame(int i)` provides acces to MotionPath objects
`int`	`getKeyFrameInfo(int type, int[] info)` Get the keyFrames for the view controlled by this MotionController the info data structure is of the the form 0 length if your are at index i the [i+len+1] is the next entry 1 type 1=Attributes, 2=Position, 3=TimeCycle 4=Cycle 5=Trigger 2 position 3 x location 4 y location 5 ...
`int`	`getKeyFramePositions(int[] type, float[] pos)` Get the keyFrames for the view controlled by this MotionController
`float`	`getStartHeight()` get the width of the widget at the start of the movement.
`float`	`getStartWidth()` get the width of the widget at the start of the movement.
`float`	`getStartX()` get the left most position of the widget at the start of the movement.
`float`	`getStartY()` get the top most position of the widget at the start of the movement.
`int`	`getTransformPivotTarget()` Get the view to pivot around
`MotionWidget`	`getView()`
`boolean`	`interpolate(MotionWidget child, float global_position, long time, KeyCache keyCache)` The main driver of interpolation
`void`	`setDrawPath(int debugMode)`
`void`	`setEnd(MotionWidget mw)`
`void`	`setPathMotionArc(int arc)`
`void`	`setStart(MotionWidget mw)`
`void`	`setStartState(ViewState rect, MotionWidget v, int rotation, int preWidth, int preHeight)`
`void`	`setTransformPivotTarget(int transformPivotTarget)` Set a view to pivot around
`void`	`setup(int parentWidth, int parentHeight, float transitionDuration, long currentTime)` Called after all TimePoints & Cycles have been added; Spines are evaluated
`void`	`setupRelative(Motion motionController)`
`boolean`	`setValue(int id, boolean value)` Used to set boolean values
`boolean`	`setValue(int id, float value)` Used to set float values
`boolean`	`setValue(int id, int value)` Used to set integer values
`boolean`	`setValue(int id, java.lang.String value)` Used to set String values
`void`	`setView(MotionWidget view)`
`java.lang.String`	`toString()` Debug string

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

- Field Detail
  - PATH_PERCENT
```
public static final int PATH_PERCENT
```
    See Also:
    
    Constant Field Values
  - PATH_PERPENDICULAR
```
public static final int PATH_PERPENDICULAR
```
    See Also:
    
    Constant Field Values
  - HORIZONTAL_PATH_X
```
public static final int HORIZONTAL_PATH_X
```
    See Also:
    
    Constant Field Values
  - HORIZONTAL_PATH_Y
```
public static final int HORIZONTAL_PATH_Y
```
    See Also:
    
    Constant Field Values
  - VERTICAL_PATH_X
```
public static final int VERTICAL_PATH_X
```
    See Also:
    
    Constant Field Values
  - VERTICAL_PATH_Y
```
public static final int VERTICAL_PATH_Y
```
    See Also:
    
    Constant Field Values
  - DRAW_PATH_NONE
```
public static final int DRAW_PATH_NONE
```
    See Also:
    
    Constant Field Values
  - DRAW_PATH_BASIC
```
public static final int DRAW_PATH_BASIC
```
    See Also:
    
    Constant Field Values
  - DRAW_PATH_RELATIVE
```
public static final int DRAW_PATH_RELATIVE
```
    See Also:
    
    Constant Field Values
  - DRAW_PATH_CARTESIAN
```
public static final int DRAW_PATH_CARTESIAN
```
    See Also:
    
    Constant Field Values
  - DRAW_PATH_AS_CONFIGURED
```
public static final int DRAW_PATH_AS_CONFIGURED
```
    See Also:
    
    Constant Field Values
  - DRAW_PATH_RECTANGLE
```
public static final int DRAW_PATH_RECTANGLE
```
    See Also:
    
    Constant Field Values
  - DRAW_PATH_SCREEN
```
public static final int DRAW_PATH_SCREEN
```
    See Also:
    
    Constant Field Values
  - ROTATION_RIGHT
```
public static final int ROTATION_RIGHT
```
    See Also:
    
    Constant Field Values
  - ROTATION_LEFT
```
public static final int ROTATION_LEFT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Motion
```
public Motion(MotionWidget view)
```
- Method Detail
  - getTransformPivotTarget
```
public int getTransformPivotTarget()
```
    Get the view to pivot around
    
    Returns:
    
    id of view or UNSET if not set
  - setTransformPivotTarget
```
public void setTransformPivotTarget(int transformPivotTarget)
```
    Set a view to pivot around
    
    Parameters:
    
    transformPivotTarget - id of view
  - getKeyFrame
```
public MotionPaths getKeyFrame(int i)
```
    provides acces to MotionPath objects
    
    Parameters:
    
    i -
    
    Returns:
  - getStartX
```
public float getStartX()
```
    get the left most position of the widget at the start of the movement.
    
    Returns:
    
    the left most position
  - getStartY
```
public float getStartY()
```
    get the top most position of the widget at the start of the movement. Positive is down.
    
    Returns:
    
    the top most position
  - getFinalX
```
public float getFinalX()
```
    get the left most position of the widget at the end of the movement.
    
    Returns:
    
    the left most position
  - getFinalY
```
public float getFinalY()
```
    get the top most position of the widget at the end of the movement. Positive is down.
    
    Returns:
    
    the top most position
  - getStartWidth
```
public float getStartWidth()
```
    get the width of the widget at the start of the movement.
    
    Returns:
    
    the width at the start
  - getStartHeight
```
public float getStartHeight()
```
    get the width of the widget at the start of the movement.
    
    Returns:
    
    the height at the start
  - getFinalWidth
```
public float getFinalWidth()
```
    get the width of the widget at the end of the movement.
    
    Returns:
    
    the width at the end
  - getFinalHeight
```
public float getFinalHeight()
```
    get the width of the widget at the end of the movement.
    
    Returns:
    
    the height at the end
  - getAnimateRelativeTo
```
public int getAnimateRelativeTo()
```
    Will return the id of the view to move relative to The position at the start and then end will be viewed relative to this view -1 is the return value if NOT in polar mode
    
    Returns:
    
    the view id of the view this is in polar mode to or -1 if not in polar
  - setupRelative
```
public void setupRelative(Motion motionController)
```
  - getCenterX
```
public float getCenterX()
```
  - getCenterY
```
public float getCenterY()
```
  - getCenter
```
public void getCenter(double p,
                      float[] pos,
                      float[] vel)
```
  - buildPath
```
public void buildPath(float[] points,
                      int pointCount)
```
    fill the array point with the center coordinates point[0] is filled with the x coordinate of "time" 0.0 mPoints[point.length-1] is filled with the y coordinate of "time" 1.0
    
    Parameters:
    
    points - array to fill (should be 2x the number of mPoints
    
    pointCount -
  - buildKeyFrames
```
public int buildKeyFrames(float[] keyFrames,
                          int[] mode,
                          int[] pos)
```
  - buildRect
```
public void buildRect(float p,
                      float[] path,
                      int offset)
```
  - addKey
```
public void addKey(MotionKey key)
```
  - setPathMotionArc
```
public void setPathMotionArc(int arc)
```
  - setup
```
public void setup(int parentWidth,
                  int parentHeight,
                  float transitionDuration,
                  long currentTime)
```
    Called after all TimePoints & Cycles have been added; Spines are evaluated
  - toString
```
public java.lang.String toString()
```
    Debug string
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
  - setView
```
public void setView(MotionWidget view)
```
  - getView
```
public MotionWidget getView()
```
  - setStart
```
public void setStart(MotionWidget mw)
```
  - setEnd
```
public void setEnd(MotionWidget mw)
```
  - setStartState
```
public void setStartState(ViewState rect,
                          MotionWidget v,
                          int rotation,
                          int preWidth,
                          int preHeight)
```
  - interpolate
```
public boolean interpolate(MotionWidget child,
                           float global_position,
                           long time,
                           KeyCache keyCache)
```
    The main driver of interpolation
    
    Parameters:
    
    child -
    
    global_position -
    
    time -
    
    keyCache -
    
    Returns:
    
    do you need to keep animating
  - getDrawPath
```
public int getDrawPath()
```
  - setDrawPath
```
public void setDrawPath(int debugMode)
```
  - getKeyFramePositions
```
public int getKeyFramePositions(int[] type,
                                float[] pos)
```
    Get the keyFrames for the view controlled by this MotionController
    
    Parameters:
    
    type - is position(0-100) + 1000*mType(1=Attributes, 2=Position, 3=TimeCycle 4=Cycle 5=Trigger
    
    pos - the x&y position of the keyFrame along the path
    
    Returns:
    
    Number of keyFrames found
  - getKeyFrameInfo
```
public int getKeyFrameInfo(int type,
                           int[] info)
```
    Get the keyFrames for the view controlled by this MotionController the info data structure is of the the form 0 length if your are at index i the [i+len+1] is the next entry 1 type 1=Attributes, 2=Position, 3=TimeCycle 4=Cycle 5=Trigger 2 position 3 x location 4 y location 5 ... length
    
    Parameters:
    
    info - is a data structure array of int that holds info on each keyframe
    
    Returns:
    
    Number of keyFrames found
  - setValue
```
public boolean setValue(int id,
                        int value)
```
    Description copied from interface: TypedValues
    
    Used to set integer values
    
    Specified by:
    
    setValue in interface TypedValues
    
    Returns:
    
    true if it accepted the value
  - setValue
```
public boolean setValue(int id,
                        float value)
```
    Description copied from interface: TypedValues
    
    Used to set float values
    
    Specified by:
    
    setValue in interface TypedValues
    
    Returns:
    
    true if it accepted the value
  - setValue
```
public boolean setValue(int id,
                        java.lang.String value)
```
    Description copied from interface: TypedValues
    
    Used to set String values
    
    Specified by:
    
    setValue in interface TypedValues
    
    Returns:
    
    true if it accepted the value
  - setValue
```
public boolean setValue(int id,
                        boolean value)
```
    Description copied from interface: TypedValues
    
    Used to set boolean values
    
    Specified by:
    
    setValue in interface TypedValues
    
    Returns:
    
    true if it accepted the value
  - getId
```
public int getId(java.lang.String name)
```
    Specified by:
    
    getId in interface TypedValues

Class Motion

Nested Class Summary

Nested classes/interfaces inherited from interface androidx.constraintlayout.core.motion.utils.TypedValues

Field Summary

Fields inherited from interface androidx.constraintlayout.core.motion.utils.TypedValues

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH_PERCENT

PATH_PERPENDICULAR

HORIZONTAL_PATH_X

HORIZONTAL_PATH_Y

VERTICAL_PATH_X

VERTICAL_PATH_Y

DRAW_PATH_NONE

DRAW_PATH_BASIC

DRAW_PATH_RELATIVE

DRAW_PATH_CARTESIAN

DRAW_PATH_AS_CONFIGURED

DRAW_PATH_RECTANGLE

DRAW_PATH_SCREEN

ROTATION_RIGHT

ROTATION_LEFT

Constructor Detail

Motion

Method Detail

getTransformPivotTarget

setTransformPivotTarget

getKeyFrame

getStartX

getStartY

getFinalX

getFinalY

getStartWidth

getStartHeight

getFinalWidth

getFinalHeight

getAnimateRelativeTo

setupRelative

getCenterX

getCenterY

getCenter

buildPath

buildKeyFrames

buildRect

addKey

setPathMotionArc

setup

toString

setView

getView

setStart

setEnd

setStartState

interpolate

getDrawPath

setDrawPath

getKeyFramePositions

getKeyFrameInfo

setValue

setValue

setValue

setValue

getId