Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UGizmoBaseVec2ParameterSource
- UGizmoPlaneScaleParameterSource
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h |
| Include | #include "BaseGizmos/ParameterToTransformAdapters.h" |
Syntax
class UGizmoPlaneScaleParameterSource : public UGizmoBaseVec2ParameterSource
Remarks
UGizmoPlaneScaleParameterSource is an UGizmoBaseVec2ParameterSource implementation that maps a 2D parameter delta to a change in a 3D scaling vector, based on the tangent axes of a 3D plane This scale is applied to an IGizmoTransformSource.
This ParameterSource is intended to be used to create 3D Plane Scale Gizmos.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TScriptInterface< IGizmoAxisSource > | AxisSource | AxisSource provides the 3D plane (origin/normal/u/v) that is used to interpret the 2D parameters |
 |
bool | bClampToZero | If true, the minimal output scale will be zero. |
 |
bool | bUseEqualScaling | If true, the scaling will be done an equal amount in each axis, using the minimal value |
 |
FVector | CurScaleAxisX | In-plane axis X for current parameter edit (only valid between BeginModify/EndModify) |
 |
FVector | CurScaleAxisY | In-plane axis Y for current parameter edit (only valid between BeginModify/EndModify) |
 |
FVector | CurScaleNormal | Plane normal for current parameter edit (only valid between BeginModify/EndModify) |
 |
FVector | CurScaleOrigin | Plane 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) |
 |
FGizmoVec2ParameterChange | LastChange | Active parameter change (only valid between BeginModify/EndModify) |
 |
FVector2D | Parameter | Parameter is the two line-equation parameters that this Vec2ParameterSource provides |
 |
TUniqueFunction< bool(const FVector &, FVector &)> | PositionConstraintFunction | Optional position constraint function. |
 |
float | ScaleMultiplier | Coordinate delta is multiplied by this amount |
 |
TScriptInterface< IGizmoTransformSource > | TransformSource | This TransformSource is updated by applying the constructed 3D translation |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UGizmoPlaneScaleParameterSource * | Construct
(
IGizmoAxisSource* AxisSourceIn, |
Create a standard instance of this ParameterSource, with the given AxisSource and TransformSource |
Overridden from IGizmoVec2ParameterSource
| 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 |
   |
FVector2D | GetParameter () |
|
  |
void | SetParameter
(
const FVector2D& NewValue |
Set value of parameter |