Skip to main content

SpringTransitionModel

Functions​

new​

</>
SpringTransitionModel.new(
showTarget: T?,--

Defaults to 1

hideTarget: T?--

Defaults to 0*showTarget

) → SpringTransitionModel<T>

A transition model that has a spring underlying it. Very useful for animations on tracks that need to be on a spring.

SetShowTarget​

</>
SpringTransitionModel.SetShowTarget(
showTarget: T?,
doNotAnimate: boolean?
) → ()

Sets the show target for the transition model

SetHideTarget​

</>
SpringTransitionModel.SetHideTarget(
hideTarget: T?,
doNotAnimate: boolean?
) → ()

Sets the hide target for the transition model

IsShowingComplete​

</>
SpringTransitionModel.IsShowingComplete(self: SpringTransitionModel<T>) → boolean

Returns true if showing is complete

IsHidingComplete​

</>
SpringTransitionModel.IsHidingComplete(self: SpringTransitionModel<T>) → boolean

Returns true if hiding is complete

ObserveIsShowingComplete​

</>
SpringTransitionModel.ObserveIsShowingComplete(self: SpringTransitionModel<T>) → Observable<boolean>

Observe is showing is complete

ObserveIsHidingComplete​

</>
SpringTransitionModel.ObserveIsHidingComplete(self: SpringTransitionModel<T>) → Observable<boolean>

Observe is hiding is complete

BindToPaneVisbility​

</>
SpringTransitionModel.BindToPaneVisbility(
pane: BasicPane
) → function--

Cleanup function

Binds the transition model to the actual visiblity of the pane

GetVelocity​

</>
SpringTransitionModel.GetVelocity(self: SpringTransitionModel<T>) → T

Returns the spring's velocity

SetEpsilon​

</>
SpringTransitionModel.SetEpsilon(
epsilon: number
) → ()

Sets the springs epsilon. This can affect how long the spring takes to finish.

SetSpeed​

</>
SpringTransitionModel.SetSpeed(
speed: number
) → ()

Sets the springs speed

SetDamper​

</>
SpringTransitionModel.SetDamper(
damper: number
) → ()

Sets the springs damper

ObserveRenderStepped​

</>
SpringTransitionModel.ObserveRenderStepped(self: SpringTransitionModel<T>) → Observable<T>

Observes the spring animating

Observe​

</>
SpringTransitionModel.Observe(self: SpringTransitionModel<T>) → Observable<T>

Alias to spring transition model observation!

PromiseShow​

</>
SpringTransitionModel.PromiseShow(
doNotAnimate: boolean
) → Promise

Shows the model and promises when the showing is complete.

PromiseHide​

</>
SpringTransitionModel.PromiseHide(
doNotAnimate: boolean
) → Promise

Hides the model and promises when the showing is complete.

PromiseToggle​

</>
SpringTransitionModel.PromiseToggle(
doNotAnimate: boolean
) → Promise

Toggles the model and promises when the transition is complete.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "A transition model that has a spring underlying it. Very useful\nfor animations on tracks that need to be on a spring.",
            "params": [
                {
                    "name": "showTarget",
                    "desc": "Defaults to 1",
                    "lua_type": "T?"
                },
                {
                    "name": "hideTarget",
                    "desc": "Defaults to 0*showTarget",
                    "lua_type": "T?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetShowTarget",
            "desc": "Sets the show target for the transition model",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "showTarget",
                    "desc": "",
                    "lua_type": "T?"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetHideTarget",
            "desc": "Sets the hide target for the transition model",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "hideTarget",
                    "desc": "",
                    "lua_type": "T?"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 83,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "IsShowingComplete",
            "desc": "Returns true if showing is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 97,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "IsHidingComplete",
            "desc": "Returns true if hiding is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 105,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "ObserveIsShowingComplete",
            "desc": "Observe is showing is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 113,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "ObserveIsHidingComplete",
            "desc": "Observe is hiding is complete",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 121,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "BindToPaneVisbility",
            "desc": "Binds the transition model to the actual visiblity of the pane",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "pane",
                    "desc": "",
                    "lua_type": "BasicPane"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup function",
                    "lua_type": "function"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 131,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "GetVelocity",
            "desc": "Returns the spring's velocity",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 161,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetEpsilon",
            "desc": "Sets the springs epsilon. This can affect how long the spring takes\nto finish.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "epsilon",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 171,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetSpeed",
            "desc": "Sets the springs speed",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "speed",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 182,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "SetDamper",
            "desc": "Sets the springs damper",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "damper",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 193,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "ObserveRenderStepped",
            "desc": "Observes the spring animating",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 203,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Alias to spring transition model observation!",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 212,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "PromiseShow",
            "desc": "Shows the model and promises when the showing is complete.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 222,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "PromiseHide",
            "desc": "Hides the model and promises when the showing is complete.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 232,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        },
        {
            "name": "PromiseToggle",
            "desc": "Toggles the model and promises when the transition is complete.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "SpringTransitionModel<T>"
                },
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 242,
                "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SpringTransitionModel",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/transitionmodel/src/Shared/SpringTransitionModel.lua"
    }
}