UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
UViewAdjustedStaticMeshGizmoComponent Class Reference

#include <ViewAdjustedStaticMeshGizmoComponent.h>

+ Inheritance diagram for UViewAdjustedStaticMeshGizmoComponent:

Public Member Functions

void SetGizmoViewContext (UGizmoViewContext *GizmoViewContextIn)
 
UE_API void SetTransformAdjuster (TSharedPtr< UE::GizmoRenderingUtil::IViewBasedTransformAdjuster > Adjuster)
 
TSharedPtr< UE::GizmoRenderingUtil::IViewBasedTransformAdjuster > GetTransformAdjuster () const
 
UE_API void SetRenderVisibilityFunction (TFunction< bool(const UE::GizmoRenderingUtil::ISceneViewInterface &View, const FTransform &ComponentToWorld)> RenderVisibilityFunc)
 
TFunction< bool(const UE::GizmoRenderingUtil::ISceneViewInterface &View, const FTransform &ComponentToWorld)> GetRenderVisibilityFunction () const
 
UE_API void SetAllMaterials (UMaterialInterface *Material)
 
UE_API void SetHoverOverrideMaterial (UMaterialInterface *Material)
 
UMaterialInterface * GetHoverOverrideMaterial ()
 
bool IsBeingHovered ()
 
UE_API void SetSubstituteInteractionComponent (UPrimitiveComponent *Component, const FTransform &RelativeTransform=FTransform::Identity)
 
bool IsHiddenByInteraction ()
 
virtual UE_API void UpdateHoverState (bool bHoveringIn) override
 
virtual UE_API void UpdateWorldLocalState (bool bWorldIn) override
 
virtual UE_API void UpdateInteractingState (bool bInteracting) override
 
virtual UE_API FMaterialRelevance GetMaterialRelevance (ERHIFeatureLevel::Type InFeatureLevel) const override
 
virtual UE_API FMaterialRelevance GetMaterialRelevance (EShaderPlatform InShaderPlatform) const override
 
virtual UE_API bool LineTraceComponent (FHitResult &OutHit, const FVector Start, const FVector End, const FCollisionQueryParams &Params) override
 
virtual UE_API FBoxSphereBounds CalcBounds (const FTransform &LocalToWorld) const override
 
virtual bool IsHLODRelevant () const override
 
virtual bool NeedsLoadForServer () const override
 

Protected Member Functions

virtual UE_API FPrimitiveSceneProxy * CreateStaticMeshSceneProxy (Nanite::FMaterialAudit &NaniteMaterials, bool bCreateNanite) override
 

Detailed Description

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.

Member Function Documentation

◆ CalcBounds()

FBoxSphereBounds UViewAdjustedStaticMeshGizmoComponent::CalcBounds ( const FTransform &  LocalToWorld) const
overridevirtual

◆ CreateStaticMeshSceneProxy()

FPrimitiveSceneProxy * UViewAdjustedStaticMeshGizmoComponent::CreateStaticMeshSceneProxy ( Nanite::FMaterialAudit &  NaniteMaterials,
bool  bCreateNanite 
)
overrideprotectedvirtual

◆ GetHoverOverrideMaterial()

UMaterialInterface * UViewAdjustedStaticMeshGizmoComponent::GetHoverOverrideMaterial ( )
inline

◆ GetMaterialRelevance() [1/2]

FMaterialRelevance UViewAdjustedStaticMeshGizmoComponent::GetMaterialRelevance ( ERHIFeatureLevel::Type  InFeatureLevel) const
overridevirtual

◆ GetMaterialRelevance() [2/2]

FMaterialRelevance UViewAdjustedStaticMeshGizmoComponent::GetMaterialRelevance ( EShaderPlatform  InShaderPlatform) const
overridevirtual

◆ GetRenderVisibilityFunction()

TFunction< bool(const UE::GizmoRenderingUtil::ISceneViewInterface &View, const FTransform &ComponentToWorld)> UViewAdjustedStaticMeshGizmoComponent::GetRenderVisibilityFunction ( ) const
inline

◆ GetTransformAdjuster()

TSharedPtr< UE::GizmoRenderingUtil::IViewBasedTransformAdjuster > UViewAdjustedStaticMeshGizmoComponent::GetTransformAdjuster ( ) const
inline

◆ IsBeingHovered()

bool UViewAdjustedStaticMeshGizmoComponent::IsBeingHovered ( )
inline

◆ IsHiddenByInteraction()

bool UViewAdjustedStaticMeshGizmoComponent::IsHiddenByInteraction ( )
inline

◆ IsHLODRelevant()

virtual bool UViewAdjustedStaticMeshGizmoComponent::IsHLODRelevant ( ) const
inlineoverridevirtual

◆ LineTraceComponent()

bool UViewAdjustedStaticMeshGizmoComponent::LineTraceComponent ( FHitResult &  OutHit,
const FVector  Start,
const FVector  End,
const FCollisionQueryParams &  Params 
)
overridevirtual

◆ NeedsLoadForServer()

virtual bool UViewAdjustedStaticMeshGizmoComponent::NeedsLoadForServer ( ) const
inlineoverridevirtual

◆ SetAllMaterials()

void UViewAdjustedStaticMeshGizmoComponent::SetAllMaterials ( UMaterialInterface *  Material)

Helper method that just sets the same material in all slots. Does not include hover override material.

◆ SetGizmoViewContext()

void UViewAdjustedStaticMeshGizmoComponent::SetGizmoViewContext ( UGizmoViewContext *  GizmoViewContextIn)
inline

The gizmo view context is needed to be able to line trace the component, since its collision data needs updating based on view.

◆ SetHoverOverrideMaterial()

void UViewAdjustedStaticMeshGizmoComponent::SetHoverOverrideMaterial ( UMaterialInterface *  Material)

Sets a material that will override all material slots whenever the component is told that is being hovered (via UpdateHoverState).

◆ SetRenderVisibilityFunction()

void UViewAdjustedStaticMeshGizmoComponent::SetRenderVisibilityFunction ( TFunction< bool(const UE::GizmoRenderingUtil::ISceneViewInterface &View, const FTransform &ComponentToWorld)>  RenderVisibilityFunc)

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). It must be callable from both the game and the render threads (for line traces and rendering).

◆ SetSubstituteInteractionComponent()

void UViewAdjustedStaticMeshGizmoComponent::SetSubstituteInteractionComponent ( UPrimitiveComponent *  Component,
const FTransform &  RelativeTransform = FTransform::Identity 
)

Sets a mesh that is swapped in while the component is being interacted with. This is done by not rendering this component and making the substitute component visible.

◆ SetTransformAdjuster()

void UViewAdjustedStaticMeshGizmoComponent::SetTransformAdjuster ( TSharedPtr< UE::GizmoRenderingUtil::IViewBasedTransformAdjuster >  Adjuster)

◆ UpdateHoverState()

void UViewAdjustedStaticMeshGizmoComponent::UpdateHoverState ( bool  bHoveringIn)
overridevirtual

Reimplemented from IGizmoBaseComponentInterface.

◆ UpdateInteractingState()

void UViewAdjustedStaticMeshGizmoComponent::UpdateInteractingState ( bool  bInteracting)
overridevirtual

Reimplemented from IGizmoBaseComponentInterface.

◆ UpdateWorldLocalState()

void UViewAdjustedStaticMeshGizmoComponent::UpdateWorldLocalState ( bool  bWorldIn)
overridevirtual

Reimplemented from IGizmoBaseComponentInterface.

The documentation for this class was generated from the following files: