Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGizmoBaseFloatParameterSource
- UGizmoAxisTranslationParameterSource
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h |
| Include | #include "BaseGizmos/ParameterToTransformAdapters.h" |
Syntax
class UGizmoAxisTranslationParameterSource : public UGizmoBaseFloatParameterSource
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TUniqueFunction< bool(double AxisDelta, double &SnappedDelta)> | AxisDeltaConstraintFunction | Optional axis delta constraint function. |
 |
TScriptInterface< IGizmoAxisSource > | AxisSource | The Parameter line-equation value is converted to a 3D Translation along this Axis |
 |
FVector | CurTranslationAxis | Tranlsation axis for current parameter edit (only valid between BeginModify/EndModify) |
 |
FVector | CurTranslationOrigin | Tranlsation 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) |
 |
float | Parameter | Parameter is the line-equation parameter that this FloatParameterSource provides |
 |
TUniqueFunction< bool(const FVector &Input, FVector &PreProjectedOutput)> | PositionConstraintFunction | Optional position constraint function. |
 |
TScriptInterface< IGizmoTransformSource > | TransformSource | This TransformSource is updated by applying the constructed 3D translation |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UGizmoAxisTranslationParameterSource * | 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 |