Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
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.
| Name | UGizmoPlaneScaleParameterSource |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ParameterToTransformAdapters.h |
| Include Path | #include "BaseGizmos/ParameterToTransformAdapters.h" |
Syntax
UCLASS (MinimalAPI)
class UGizmoPlaneScaleParameterSource : public UGizmoBaseVec2ParameterSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UGizmoBaseVec2ParameterSource → UGizmoPlaneScaleParameterSource
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 | |
| bClampToZero | bool | If true, the minimal output scale will be zero. | BaseGizmos/ParameterToTransformAdapters.h | |
| bUseEqualScaling | bool | If true, the scaling will be done an equal amount in each axis, using the minimal value | BaseGizmos/ParameterToTransformAdapters.h | |
| CurScaleAxisX | FVector | In-plane axis X for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurScaleAxisY | FVector | In-plane axis Y for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurScaleNormal | FVector | Plane normal for current parameter edit (only valid between BeginModify/EndModify) | BaseGizmos/ParameterToTransformAdapters.h | |
| CurScaleOrigin | 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 &, FVector &)> | Optional position constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| ScaleAxisXDeltaConstraintFunction | TUniqueFunction< bool(double ScaleAxisDelta, double &SnappedScaleAxisDelta)> | Optional scale axis delta constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| ScaleAxisYDeltaConstraintFunction | TUniqueFunction< bool(double ScaleAxisDelta, double &SnappedScaleAxisDelta)> | BaseGizmos/ParameterToTransformAdapters.h | ||
| ScaleConstraintFunction | TUniqueFunction< FVector2D(const FVector2D &)> | Optional scale constraint function. | BaseGizmos/ParameterToTransformAdapters.h | |
| ScaleMultiplier | float | Coordinate delta is multiplied by this amount | 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 UGizmoPlaneScaleParameterSource * Construct
(
IGizmoAxisSource* AxisSourceIn, |
Create a standard instance of this ParameterSource, with the given AxisSource and TransformSource | BaseGizmos/ParameterToTransformAdapters.h |