Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
UGizmoAxisRotationParameterSource is an IGizmoVec2ParameterSource implementation that interprets the FVector2D parameter as a position in a 2D plane, and maps this position to a 3D translation in a plane with origin/normal given by an IGizmoAxisSource. This translation is applied to an IGizmoTransformSource.
This ParameterSource is intended to be used to create 3D Plane Translation Gizmos.
| Name | UGizmoPlaneTranslationParameterSource |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h |
| Include Path | #include "BaseGizmos/ParameterToTransformAdapters.h" |
Syntax
UCLASS (MinimalAPI)
class UGizmoPlaneTranslationParameterSource : public UGizmoBaseVec2ParameterSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoBaseVec2ParameterSource → UGizmoPlaneTranslationParameterSource
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AxisSource | TScriptInterface< IGizmoAxisSource > | AxisSource provides the 3D plane (origin/normal/u/v) that is used to interpret the 2D parameters | BaseGizmos/ParameterToTransformAdapters.h | |
| AxisXDeltaConstraintFunction | TUniqueFunction< bool(double AxisDelta, double &SnappedDelta)> | Optional axis delta constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| AxisYDeltaConstraintFunction | TUniqueFunction< bool(double AxisDelta, double &SnappedDelta)> | BaseGizmos/ParameterToTransformAdapters.h | ||
| bProjectConstrainedPosition | bool | When true, the output of PositionConstraintFunction will be projected onto the current translation origin/axis. | BaseGizmos/ParameterToTransformAdapters.h | |
| CurTranslationAxisX | FVector | In-plane axis X for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurTranslationAxisY | FVector | In-plane axis Y for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurTranslationNormal | FVector | Plane normal for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurTranslationOrigin | FVector | Plane 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 | FGizmoVec2ParameterChange | Active parameter change (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| Parameter | FVector2D | Parameter is the two line-equation parameters that this Vec2ParameterSource provides | BaseGizmos/ParameterToTransformAdapters.h | |
| PositionConstraintFunction | TUniqueFunction< bool(const FVector &Input, FVector &PreProjectedOutput)> | Optional position constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| TransformSource | TScriptInterface< IGizmoTransformSource > | This TransformSource is updated by applying the constructed 3D translation | BaseGizmos/ParameterToTransformAdapters.h |
Functions
Public
Overridden from IGizmoVec2ParameterSource
| 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 FVector2D GetParameter() |
BaseGizmos/ParameterToTransformAdapters.h | ||
virtual void SetParameter
(
const FVector2D& NewValue |
Set value of parameter | BaseGizmos/ParameterToTransformAdapters.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UGizmoPlaneTranslationParameterSource * Construct
(
IGizmoAxisSource* AxisSourceIn, |
Create a standard instance of this ParameterSource, with the given AxisSource and TransformSource | BaseGizmos/ParameterToTransformAdapters.h |