1. Epic GamesDeveloper
  3. UAvaGizmoComponent

UAvaGizmoComponent

Add to an actor to indicate it's used as a Gizmo.

API > API/Plugins > API/Plugins/Avalanche > API/Plugins/Avalanche/Framework

Inheritance Hierarchy

References

   
Module Avalanche
Header /Engine/Plugins/Experimental/Avalanche/Source/Avalanche/Public/Framework/AvaGizmoComponent.h
Include #include "Framework/AvaGizmoComponent.h"

Syntax

UCLASS (DisplayName="Motion Design Gizmo Component", Meta=(BlueprintSpawnableComponent))  
class UAvaGizmoComponent : public UActorComponent

Remarks

Add to an actor to indicate it's used as a Gizmo.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite getter, setter bool bApplyToChildActors Whether the settings apply to child actors or not.
Protected variable UProperty bool bAreGizmoValuesApplied Whether the gizmo values are actually applied.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bCastShadow Controls whether the primitive component should cast a shadow or not.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bDrawWireframe Currently only applies to dynamic meshes.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bIsGizmoEnabled Whether "gizmo mode" is enabled.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bIsHiddenInGame Whether to hide the primitive in game, if the primitive is Visible.
Protected variable std::atomic< bool > bIsRestoringValues  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bIsVisibleInEditor Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bRenderDepth Whether to render to the depth buffer.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bRenderInMainPass Whether to render in the main pass.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter bool bSetStencil Whether to render to the custom depth/stencil buffer.
Protected variable UProperty TMap< FSoftComponentReference, FAvaGizmoComponentPrimitiveValues > ComponentValues Original values to restore upon component removal.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter TObjectPtr< UMaterialInterface > Material Material that overrides all others attached to the parent actor, if specified.
Protected variable FDelegateHandle PostRegisterComponentsHandle  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter uint8 StencilId The custom stencil id, if applicable.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FLinearColor WireframeColor The color of the wireframe when drawn.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool Whether the settings apply to child actors or not.
Public function void Applies the gizmo values to all primitive components in the parent actor.
Public function Const bool Whether the primitive component should cast a shadow or not.
Public function Const UMaterialInterface * The (optional) material to use.
Public function Const const uint8 The custom stencil id, if applicable.
Public function Const const bool Whether "gizmo mode" is enabled.
Public function Const bool Whether to hide the primitive in game, if the primitive is Visible.
Public function Const bool Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.
Public function Const bool Whether to render to the depth buffer.
Public function Const bool Whether to render in the main pass.
Public function void Applies the original (visibility etc) property values to the Actor. Use prior to component removal.
Public function void

SetApplyToChildActors ( bool bInValue
)

 Sets whether the settings apply to child actors or not.
Public function void

SetCastShadow ( bool bInValue
)

 Controls whether the primitive component should cast a shadow or not.
Public function void

SetGizmoEnabled ( const bool bInIsEnabled
)

 Sets whether "gizmo mode" is enabled.
Public function void

SetHiddenInGame ( bool bInValue
)

 Whether to hide the primitive in game, if the primitive is Visible.
Public function void Set the material to use.
Public function void Sets the material to engine default.
Public function void Set the material to a see through one.
Public function void

SetRenderDepth ( const bool bInValue
)

 Sets whether to render to the depth buffer.
Public function void

SetRenderInMainPass ( const bool bInValue
)

 Sets whether to render in the main pass.
Public function void

SetShowWireframe ( bool bInValue
)

 Whether to draw the mesh wireframe, currently only applicable to Dynamic Meshes.
Public function Const bool Whether to render to the custom depth/stencil buffer.
Public function void

SetsStencil ( const bool bInSetStencil
)

 Sets whether to render to the custom depth/stencil buffer.
Public function void

SetStencilId ( const uint8 InStencilId
)

 Sets the custom stencil id, if applicable.
Public function void

SetVisibleInEditor ( bool bInValue
)

 Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.
Public function void

SetWireframeColor ( const FLinearColor& InColor
)

 The color of the wireframe when drawn.
Public function Const bool Whether to draw the mesh wireframe, currently only applicable to Dynamic Meshes.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Called when a component is created (not loaded). This can happen in the editor or during gameplay
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

 Called when a component is destroyed
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page