mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
151 lines
4.6 KiB
YAML
151 lines
4.6 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: EulerRotationCurve
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Represents a 3D rotation curve through a group of three
|
|
`Class.FloatCurve|FloatCurves`.
|
|
description: |
|
|
A **EulerRotationCurve** represents a 3D rotation curve through a group of
|
|
three `Class.FloatCurve|FloatCurves`. The rotation is decomposed in three
|
|
Euler angles channels that can be accessed via `Class.EulerRotationCurve:X()`,
|
|
`Class.EulerRotationCurve:Y()`, and `Class.EulerRotationCurve:Z()`. The three
|
|
axes can be sampled simultaneously via
|
|
`Class.EulerRotationCurve:GetAnglesAtTime()`, returning the three Euler angles
|
|
as a `Datatype.Vector3`. Similarly,
|
|
`Class.EulerRotationCurve:GetRotationAtTime()` samples all channels
|
|
simultaneously but returns a `Datatype.CFrame` rotated by `X`, `Y`, and `Z`
|
|
according to the specified rotation order.
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: EulerRotationCurve.RotationOrder
|
|
summary: |
|
|
Euler angles rotation order.
|
|
description: |
|
|
Euler angles rotation order
|
|
code_samples: []
|
|
type: RotationOrder
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Basic
|
|
methods:
|
|
- name: EulerRotationCurve:GetAnglesAtTime
|
|
summary: |
|
|
Samples the three `Class.FloatCurve|FloatCurves` (`X`, `Y`, `Z`) at the
|
|
passed `time` argument and returns the result as three Euler angles.
|
|
description: |
|
|
Samples the three `Class.FloatCurve|FloatCurves` (`X`, `Y`, `Z`) at the
|
|
passed `time` argument and returns the result as three Euler angles. If a
|
|
channel curve is missing or no key is found in the curve, the channel is
|
|
evaluated as `nil`.
|
|
code_samples: []
|
|
parameters:
|
|
- name: time
|
|
type: float
|
|
default:
|
|
summary: ''
|
|
returns:
|
|
- type: Array
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: EulerRotationCurve:GetRotationAtTime
|
|
summary: |
|
|
Samples the `Class.EulerRotationCurve` at a given `time` and returns the
|
|
corresponding rotation.
|
|
description: |
|
|
Samples the `Class.EulerRotationCurve` at a given `time` and returns the
|
|
corresponding rotation. Empty Euler angles channels are interpreted as
|
|
zero.
|
|
code_samples: []
|
|
parameters:
|
|
- name: time
|
|
type: float
|
|
default:
|
|
summary: ''
|
|
returns:
|
|
- type: CFrame
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: EulerRotationCurve:X
|
|
summary: |
|
|
Returns the `Class.FloatCurve` controlling the `X` Euler angle channel.
|
|
description: |
|
|
Returns the `Class.FloatCurve` controlling the `X` Euler angle channel. It
|
|
is the first child instance of type `Class.FloatCurve` named `X`. If none
|
|
is found, an empty `Class.FloatCurve` is created.
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: FloatCurve
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: EulerRotationCurve:Y
|
|
summary: |
|
|
Returns the `Class.FloatCurve` controlling the `Y` Euler angle channel.
|
|
description: |
|
|
Returns the `Class.FloatCurve` controlling the `Y` Euler angle channel. It
|
|
is the first child instance of type `Class.FloatCurve` named `Y`. If none
|
|
is found, an empty `Class.FloatCurve` is created.
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: FloatCurve
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
- name: EulerRotationCurve:Z
|
|
summary: |
|
|
Returns the `Class.FloatCurve` controlling the `Z` Euler angle channel.
|
|
description: |
|
|
Returns the `Class.FloatCurve` controlling the `Z` Euler angle channel. It
|
|
is the first child instance of type `Class.FloatCurve` named `Z`. If none
|
|
is found, an empty `Class.FloatCurve` is created.
|
|
code_samples: []
|
|
parameters: []
|
|
returns:
|
|
- type: FloatCurve
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Basic
|
|
events: []
|
|
callbacks: []
|