Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGizmoBaseFloatParameterSource
- UGizmoAxisScaleParameterSource
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h |
| Include | #include "BaseGizmos/ParameterToTransformAdapters.h" |
Syntax
class UGizmoAxisScaleParameterSource : public UGizmoBaseFloatParameterSource
Remarks
UGizmoAxisScaleParameterSource is an IGizmoFloatParameterSource implementation that interprets the float value as the parameter of a line equation, and maps this parameter to a scale factor along a line with origin/direction given by an IGizmoAxisSource. This scale is applied to an IGizmoTransformSource.
This ParameterSource is intended to be used to create 3D Axis Scale Gizmos.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TScriptInterface< IGizmoAxisSource > | AxisSource | The Parameter line-equation value is converted to a 3D Translation along this Axis | |
| bool | bClampToZero | If true, the minimal output scale will be zero. | |
| FVector | CurScaleAxis | Scale axis for current parameter edit (only valid between BeginModify/EndModify) | |
| FVector | CurScaleOrigin | Scale 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 | |
| float | ScaleMultiplier | Coordinate delta is multiplied by this amount | |
| TScriptInterface< IGizmoTransformSource > | TransformSource | This TransformSource is updated by applying the constructed 3D rotation |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UGizmoAxisScaleParameterSource * | 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 () |
Optional position constraint function. | |
| void | SetParameter
(
float NewValue |
Set value of parameter |