Skip to main content

TimedTransitionModel

Functions​

new​

</>
TimedTransitionModel.new(
transitionTime: number?--

Optional

) → TimedTransitionModel<T>

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

IsShowingComplete​

</>
TimedTransitionModel:IsShowingComplete() → boolean

Returns true if showing is complete

IsHidingComplete​

</>
TimedTransitionModel:IsHidingComplete() → boolean

Returns true if hiding is complete

ObserveIsShowingComplete​

</>
TimedTransitionModel:ObserveIsShowingComplete() → Observable<boolean>

Observe is showing is complete

ObserveIsHidingComplete​

</>
TimedTransitionModel:ObserveIsHidingComplete() → Observable<boolean>

Observe is hiding is complete

BindToPaneVisbility​

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

Cleanup function

Binds the transition model to the actual visiblity of the pane

ObserveRenderStepped​

</>
TimedTransitionModel:ObserveRenderStepped() → Observable<T>

Observes the spring animating

Observe​

</>
TimedTransitionModel:Observe() → Observable<T>

Alias to spring transition model observation!

PromiseShow​

</>
TimedTransitionModel:PromiseShow(doNotAnimate: boolean) → Promise

Shows the model and promises when the showing is complete.

PromiseHide​

</>
TimedTransitionModel:PromiseHide(doNotAnimate: boolean) → Promise

Hides the model and promises when the showing is complete.

PromiseToggle​

</>
TimedTransitionModel: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": "transitionTime",
                    "desc": "Optional",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "TimedTransitionModel<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "IsShowingComplete",
            "desc": "Returns true if showing is complete",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 51,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "IsHidingComplete",
            "desc": "Returns true if hiding is complete",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "ObserveIsShowingComplete",
            "desc": "Observe is showing is complete",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 67,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "ObserveIsHidingComplete",
            "desc": "Observe is hiding is complete",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 75,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "BindToPaneVisbility",
            "desc": "Binds the transition model to the actual visiblity of the pane",
            "params": [
                {
                    "name": "pane",
                    "desc": "",
                    "lua_type": "BasicPane"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup function",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 85,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "ObserveRenderStepped",
            "desc": "Observes the spring animating",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 114,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "Observe",
            "desc": "Alias to spring transition model observation!",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<T>"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 123,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "PromiseShow",
            "desc": "Shows the model and promises when the showing is complete.",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 133,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "PromiseHide",
            "desc": "Hides the model and promises when the showing is complete.",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 143,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        },
        {
            "name": "PromiseToggle",
            "desc": "Toggles the model and promises when the transition is complete.",
            "params": [
                {
                    "name": "doNotAnimate",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 153,
                "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "TimedTransitionModel",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/transitionmodel/src/Shared/Timed/TimedTransitionModel.lua"
    }
}