Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
UGizmoAxisRotationParameterSource is an IGizmoFloatParameterSource implementation that interprets the float parameter as an angle, and maps this angle to a 3D rotation around an IGizmoAxisSource (ie 3D axis). This rotation is applied to an IGizmoTransformSource. This ParameterSource is intended to be used to create 3D Rotation Gizmos.
| Name | UGizmoAxisRotationParameterSource |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h |
| Include Path | #include "BaseGizmos/ParameterToTransformAdapters.h" |
Syntax
UCLASS (MinimalAPI)
class UGizmoAxisRotationParameterSource : public UGizmoBaseFloatParameterSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoBaseFloatParameterSource → UGizmoAxisRotationParameterSource
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Angle | float | Angle is the parameter that this FloatParameterSource provides | BaseGizmos/ParameterToTransformAdapters.h | |
| AngleDeltaConstraintFunction | TUniqueFunction< bool(double AngleDelta, double &SnappedAngleDelta)> | Optional axis-delta-angle constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| AxisSource | TScriptInterface< IGizmoAxisSource > | Float-parameter Angle is mapped to a 3D Rotation around this Axis | BaseGizmos/ParameterToTransformAdapters.h | |
| CurRotationAxis | FVector | Rotation axis for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurRotationOrigin | FVector | Rotation origin for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| InitialTransform | FTransform | Saved copy of Initial Transform for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| LastChange | FGizmoFloatParameterChange | Active parameter change (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| RotationConstraintFunction | TUniqueFunction< FQuat(const FQuat &)> | Optional rotation constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| TransformSource | TScriptInterface< IGizmoTransformSource > | This TransformSource is updated by applying the constructed 3D rotation | BaseGizmos/ParameterToTransformAdapters.h |
Functions
Public
Overridden from IGizmoFloatParameterSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginModify() |
Notify ParameterSource that a parameter modification is about to begin | BaseGizmos/ParameterToTransformAdapters.h | |
virtual void EndModify() |
Notify ParameterSource that a parameter modification is complete | BaseGizmos/ParameterToTransformAdapters.h | |
virtual float GetParameter() |
BaseGizmos/ParameterToTransformAdapters.h | ||
virtual void SetParameter
(
float NewValue |
Set value of parameter | BaseGizmos/ParameterToTransformAdapters.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UGizmoAxisRotationParameterSource * Construct
(
IGizmoAxisSource* AxisSourceIn, |
Create a standard instance of this ParameterSource, with the given AxisSource and TransformSource | BaseGizmos/ParameterToTransformAdapters.h |