Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
Version of a static mesh component that only takes the dynamic draw path and has the ability to adjust the transform based on view information.
| Name | UViewAdjustedStaticMeshGizmoComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h |
| Include Path | #include "BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, BlueprintType, ClassGroup=Gizmos,
Meta=(BlueprintSpawnableComponent))
class UViewAdjustedStaticMeshGizmoComponent :
public UStaticMeshComponent,
public IGizmoBaseComponentInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMeshComponent → UStaticMeshComponent → UViewAdjustedStaticMeshGizmoComponent
Implements Interfaces
- IGizmoBaseComponentInterface
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHovered | bool | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
| bInteracted | bool | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
| GizmoViewContext | TObjectPtr< UGizmoViewContext > | Needed for proper line traces. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
| HoverOverrideMaterial | TObjectPtr< UMaterialInterface > | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
| RenderVisibilityFunc | TFunction< bool(const UE::GizmoRenderingUtil::ISceneViewInterface &View, const FTransform &ComponentToWorld)> | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
| SubstituteInteractionComponent | TObjectPtr< UPrimitiveComponent > | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
| TransformAdjuster | TSharedPtr< UE::GizmoRenderingUtil::IViewBasedTransformAdjuster > | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBoxSphereBounds CalcBounds
(
const FTransform& LocalToWorld |
USceneComponent. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
UMaterialInterface * GetHoverOverrideMaterial() |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
virtual FMaterialRelevance GetMaterialRelevance
(
ERHIFeatureLevel::Type InFeatureLevel |
UMeshComponent | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
virtual FMaterialRelevance GetMaterialRelevance
(
EShaderPlatform InShaderPlatform |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
TFunction< bool(const UE::GizmoRenderingUtil::ISceneViewInterface &View, const FTransform &ComponentToWorld)> GetRenderVisibilityFunction() |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
TSharedPtr< UE::GizmoRenderingUtil::IViewBasedTransformAdjuster > GetTransformAdjuster() |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
bool IsBeingHovered() |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
bool IsHiddenByInteraction() |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
virtual bool IsHLODRelevant() |
UActorComponent. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
virtual bool LineTraceComponent
(
FHitResult& OutHit, |
UPrimitiveComponent. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
virtual bool NeedsLoadForServer() |
UObject. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
void SetAllMaterials
(
UMaterialInterface* Material |
Helper method that just sets the same material in all slots. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
void SetGizmoViewContext
(
UGizmoViewContext* GizmoViewContextIn |
The gizmo view context is needed to be able to line trace the component, since its collision data needs updating based on view. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
void SetHoverOverrideMaterial
(
UMaterialInterface* Material |
Sets a material that will override all material slots whenever the component is told that is being hovered (via UpdateHoverState). | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
void SetRenderVisibilityFunction
(
TFunction< bool(const UE::GizmoRenderingUtil::ISceneViewInterface&View, const FTransform&Component... |
The render visibility function is an optional function that can hide the component based on view information (for instance to hide an arrow gizmo when looking directly down the arrow). | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
void SetSubstituteInteractionComponent
(
UPrimitiveComponent* Component, |
Sets a mesh that is swapped in while the component is being interacted with. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | |
void SetTransformAdjuster
(
TSharedPtr< UE::GizmoRenderingUtil::IViewBasedTransformAdjuster > Adjuster |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h |
Overridden from IGizmoBaseComponentInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateHoverState
(
bool bHoveringIn |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
virtual void UpdateInteractingState
(
bool bInteracting |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h | ||
virtual void UpdateWorldLocalState
(
bool bWorldIn |
BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPrimitiveSceneProxy * CreateStaticMeshSceneProxy
(
Nanite::FMaterialAudit& NaniteMaterials, |
UStaticMeshComponent. | BaseGizmos/ViewAdjustedStaticMeshGizmoComponent.h |