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