Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Various 1D and 2D ParameterSource converters intended to be used to create 3D transformation gizmos. Based on base classes in ParameterSourcesFloat.h and ParameterSourcesVec2.hUGizmoAxisTranslationParameterSource is an IGizmoFloatParameterSource implementation that interprets the float value as the parameter of a line equation, and maps this parameter to a 3D translation along a line with origin/direction given by an IGizmoAxisSource. This translation is applied to an IGizmoTransformSource.
This ParameterSource is intended to be used to create 3D Axis Translation Gizmos.
| Name | UGizmoAxisTranslationParameterSource |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h |
| Include Path | #include "BaseGizmos/ParameterToTransformAdapters.h" |
Syntax
UCLASS (MinimalAPI)
class UGizmoAxisTranslationParameterSource : public UGizmoBaseFloatParameterSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoBaseFloatParameterSource → UGizmoAxisTranslationParameterSource
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AxisDeltaConstraintFunction | TUniqueFunction< bool(double AxisDelta, double &SnappedDelta)> | Optional axis delta constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| AxisSource | TScriptInterface< IGizmoAxisSource > | The Parameter line-equation value is converted to a 3D Translation along this Axis | BaseGizmos/ParameterToTransformAdapters.h | |
| CurTranslationAxis | FVector | Tranlsation axis for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurTranslationOrigin | FVector | Tranlsation 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 | |
| Parameter | float | Parameter is the line-equation parameter that this FloatParameterSource 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 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 UGizmoAxisTranslationParameterSource * Construct
(
IGizmoAxisSource* AxisSourceIn, |
Create a standard instance of this ParameterSource, with the given AxisSource and TransformSource | BaseGizmos/ParameterToTransformAdapters.h |