1. Epic GamesDeveloper
  3. UAvaShapeDynamicMeshBase

UAvaShapeDynamicMeshBase

API > API/Plugins > API/Plugins/AvalancheShapes > API/Plugins/AvalancheShapes/DynamicMeshes

Inheritance Hierarchy

References

   
Module AvalancheShapes
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheShapes/Public/DynamicMeshes/AvaShapeDynMeshBase.h
Include #include "DynamicMeshes/AvaShapeDynMeshBase.h"

Syntax

UCLASS (MinimalAPI, ClassGroup="Shape", Abstract, BlueprintType, CustomConstructor, EditInlineNew,  
       DefaultToInstanced, HideCategories=(Tags, Activation, Cooking, AssetUserData, Navigation))  
class UAvaShapeDynamicMeshBase :  
    public UActorComponent ,  
    public IAvaInteractiveToolsModeDetailsObject ,  
    public IAvaGizmoObjectInterface

Variables

  Type Name Description
Protected variable UProperty Category, EditDefaultsOnly BlueprintReadOnly bool bAllowEditSize Enable mesh size property editing
Protected variable UProperty Category, Meta BlueprintReadWrite editinstanceonly, getter, setter bool bUsePrimaryMaterialEverywhere Use primary material for every slot available
Protected variable TArray< FAvaSnapPoint > LocalSnapPoints  
Protected variable UProperty Category, Meta BlueprintReadOnly editinstanceonly TMap< int32, FAvaShapeMeshData > MeshDatas Meshes used for the current shape sections.
Protected variable UProperty Category, Meta BlueprintReadWrite Transient editinstanceonly ESizeType SizeType The type of size you want to handle
Protected variable UProperty Category, Meta BlueprintReadWrite Transient editinstanceonly, getter, setter float UniformScaledSize Uniform scaled size of the mesh.
Protected variable UProperty Category, AdvancedDisplay, Meta BlueprintReadWrite FLinearColor VertexColor  

Constructors

  Type Name Description
Public function  

UAvaShapeDynamicMeshBase ( const FObjectInitializer& ObjectInitializer
)

  
Public function  

UAvaShapeDynamicMeshBase ( const FLinearColor& InVertexColor,
float InUniformScaledSize,
bool bInAllowEditSize
)

  

Functions

  Type Name Description
Public function Const bool Can we change the size of this shape
Protected function bool

ApplyUVsBoxProjection ( FAvaShapeMesh& InMesh,
FRotator BoxRotation,
FVector BoxSize
)

 Apply a box projection on a dynamic mesh section
Protected function bool Sets the uvs manually on a dynamic mesh section
Protected function bool

ApplyUVsPlanarProjection ( FAvaShapeMesh& InMesh,
FRotator PlaneRotation,
FVector2D PlaneSize
)

 Apply a planar projection on a dynamic mesh section
Public function Const bool

ApplyUVsTransform ( FAvaShapeMesh& InMesh,
FAvaShapeMaterialUVParameters& InParams,
FVector2D ShapeSize,
FVector2D UVFixOffset,
float UVFixRotation
)

 Apply scale, offset, rotation on dynamic mesh section
Protected function bool Used to check for material changes in slot of DMC to match with our current material settings
Public function bool Clear the whole dynamic mesh
Public function bool Clear the dynamic mesh section with a specific index
Protected function Virtual bool Clears the mesh sections that are dirty.
Protected function Virtual bool Adds vertex colors to the vertex colour array. Does not empty it.
Protected function bool Creates a section in the dynamic mesh component.
Protected function Virtual bool Override this in child classes to create the mesh if it's visible
Protected function Virtual bool Override this in child classes when you create UV for a specific mesh
Public function bool

ExportToStaticMesh ( UStaticMesh* DestinationMesh
)

 Converts dynamic mesh to static mesh
Public function Virtual Const FAvaColorChangeData  
Protected function Static EAvaAnchors

GetAnchorFromNumerics ( const FVector2D& AnchorNumeric
)

  
Public function Virtual Const void

GetBounds ( FVector& Origin,
FVector& BoxExtent,
FVector& Pivot
)

 Gets the bounds of the shape, override this in child classes for custom bounds Origin is the center of the box, BoxExtent is half the size, pivot is the default location of the pivot for this shape
Public function FAvaShapeMaterialUVParameters *  
Public function Const const FAvaShapeMaterialUVParameters *  
Public function Const void  
Public function Virtual Const TArray< FAvaSnapPoint > Generate a list of 3d-space snap points for this shape.
Public function Const UMaterialInterface *

GetMaterial ( int32 MeshIndex
)

  
Public function Const bool  
Protected function EMaterialType &

GetMaterialType ( int32 MeshIndex
)

  
Public function Const const FVector2D &

GetMaterialUVAnchor ( int32 MeshIndex
)

  
Public function Const EAvaAnchors  
Public function Const EAvaShapeUVMode

GetMaterialUVMode ( int32 MeshIndex
)

 Helper function to quickly get what you need instead of using GetMeshData()
Public function Const const FVector2D &

GetMaterialUVOffset ( int32 MeshIndex
)

  
Protected function FAvaShapeMaterialUVParameters *

GetMaterialUVParams ( int32 MeshIndex
)

  
Public function Const const FAvaShapeMaterialUVParameters *

GetMaterialUVParams ( int32 MeshIndex
)

  
Public function Const float  
Public function Const const FVector2D &

GetMaterialUVScale ( int32 MeshIndex
)

  
Public function Const bool  
Public function FAvaShapeMeshData *

GetMeshData ( int32 MeshIndex
)

 Find a registered mesh and gets a pointer to it
Protected function const TArray< UMaterialInterface * > Returns the materials used by every mesh
Protected function Const FName

GetMeshDataName ( int32 InMeshIndex
)

 Returns the name of the mesh
Public function Const TArray< FName > Returns the name of the meshes
Public function Const TSet< int32 > Get the registered meshes indexes
Public function Virtual Const const FString & Get the name of the shape
Public function Const const FVector &  
Protected function Const EAvaDynamicMeshUpdateState  
Protected function Static FVector2D  
Public function Const const FAvaShapeParametricMaterial *  
Public function FAvaShapeParametricMaterial *  
Public function Const AAvaShapeActor * Converts the Outer of this object to a AAvaShapeActor.
Public function Const UDynamicMeshComponent * Gets the Dynamic Mesh component from the Shape actor, this will load it if its nullptr.
Public function Virtual Const const FVector &  
Public function Const FTransform  
Public function Const float  
Public function Const bool  
Public function Const bool  
Protected function bool Checks whether the topology of the mesh has changed (different vertices count and different triangles count than current)
Protected function void Clears everything and reinitialize the DM to use it properly
Protected function void

InvalidateSection ( bool& bInvalidatedSection,
bool bRequireUpdate,
bool bDoAsync
)

 Invalidates a section and runs the mesh update if necessary.
Protected function Const bool Checks to see if attributes are initialized and mesh is ready
Public function bool

IsMaterialType ( int32 MeshIndex,
EMaterialType Type
)

  
Protected function Virtual bool

IsMeshDirty ( int32 MeshIndex
)

 Returns whether the mesh is dirty, called before creating mesh if visible
Public function Const bool Checks if shape size is render-able and not minimal
Protected function Virtual bool

IsMeshVisible ( int32 MeshIndex
)

 Override this in child classes, called before creating mesh if visible
Public function Const bool

IsValidMeshIndex ( int32 MeshIndex
)

 Checks if the mesh section is valid
Protected function void Flag all mesh sections dirty to regenerate them
Protected function void

MarkMeshDirty ( int32 MeshIndex
)

 Flag a mesh section dirty to regenerate it
Protected function void Only update vertices from mesh
Protected function void

OnAssetDropped ( UObject* DroppedObj,
AActor* TargetActor
)

 Triggers when we drop an asset (material) onto our actor
Public function Virtual void

OnColorPicked ( const FAvaColorChangeData& InNewColorData
)

  
Protected function Virtual void

OnMaterialChanged ( int32 MaterialIndex
)

  
Protected function Virtual void

OnMaterialTypeChanged ( int32 MaterialIndex
)

  
Protected function Virtual void

OnMeshChanged ( int32 MeshIndex
)

  
Protected function Virtual bool  
Protected function Virtual void Called once the mesh is done updating
Protected function void When a parametric material is updated.
Protected function Virtual void  
Protected function Virtual void Called once the pixel size has changed, only in editor
Protected function Virtual void

OnRegisteredMesh ( int32 MeshIndex
)

 Called when a new mesh has been registered
Protected function Virtual void Called when all the meshes have been registered and the setup is done
Protected function Virtual void Override this in child classes
Protected function Virtual void Override this in child classes, for 2D and 3D shape to update the scale
Protected function Virtual void  
Protected function Virtual void

OnUVParamsChanged ( int32 MeshIndex
)

  
Protected function Virtual void  
Protected function bool

RegisterMesh ( FAvaShapeMeshData& NewMeshData
)

 Call to register meshes used for this shape, call this inside RegisterMeshes()
Protected function Virtual void Override this in child classes, to register new meshes
Protected function void

RequireUpdate ( bool bDoAsync
)

 Runs the update for this mesh, async by default
Protected function void

ScaleVertices ( const FVector2D& InScale
)

  
Protected function void

ScaleVertices ( const FVector& InScale
)

 Scale the vertices on all sections of the mesh
Protected function Static bool

SetAlignmentSize ( AActor* InActor,
const FVector& InSizeMultiplier
)

  
Public function bool

SetMaterial ( int32 MeshIndex,
UMaterialInterface* NewMaterial
)

  
Protected function bool

SetMaterialDirect ( int32 MeshIndex,
UMaterialInterface* NewMaterial
)

  
Public function bool

SetMaterialHorizontalFlip ( int32 MeshIndex,
bool InHorizontalFlip
)

  
Public function bool

SetMaterialType ( int32 MeshIndex,
EMaterialType Type
)

  
Public function bool

SetMaterialUVAnchor ( int32 MeshIndex,
const FVector2D& InUVAnchor
)

  
Public function bool

SetMaterialUVAnchorPreset ( int32 MeshIndex,
EAvaAnchors InUVAnchorPreset
)

  
Public function bool

SetMaterialUVMode ( int32 MeshIndex,
EAvaShapeUVMode InUVMode
)

  
Public function bool

SetMaterialUVOffset ( int32 MeshIndex,
const FVector2D& InUVOffset
)

  
Public function bool  
Public function bool

SetMaterialUVRotation ( int32 MeshIndex,
float InUVRotation
)

  
Public function bool

SetMaterialUVScale ( int32 MeshIndex,
const FVector2D& InUVScale
)

  
Public function bool

SetMaterialVerticalFlip ( int32 MeshIndex,
bool InVerticalFlip
)

  
Public function void

SetMeshRegenWorldLocation ( const FVector& NewLocation,
bool bImmediateUpdate
)

  
Public function bool

SetOverridePrimaryUVParams ( int32 MeshIndex,
bool bOverride
)

 Allows custom uv params per mesh section instead of using the primary one.
Public function bool

SetParametricMaterial ( int32 MeshIndex,
const FAvaShapeParametricMaterial& NewMaterialParams
)

 Internal materials are not copied over, only settings.
Protected function void

SetShapeComponentMaterial ( int32 InMaterialIndex,
UMaterialInterface* InNewMaterial
)

 Changes the material on the shape component and keeps the MDI up to date.
Public function Virtual void

SetSize3D ( const FVector& InSize
)

 Override in child classes, represents the mesh size
Public function void

SetUniformScaledSize ( float InSize
)

  
Protected function void Register all meshes once, calls RegisterMeshes()
Public function void Primary material override.
Protected function Virtual void

ToggleGizmo_Implementation ( const UAvaGizmoComponent* InGizmoComponent,
const bool bShowAsGizmo
)

  
Protected function Virtual bool Performs a vertex-colour-only update. Then calls OnMeshUpdate to the PMC.
Protected function void Takes all dirty flags, regenerate whatever is needed and updates the DMC, called by RunUpdate or RequireUpdate.
Protected function bool Updates a section in the dynamic mesh component.
Protected function Virtual void Special case when the mesh is scaled, rather than reconfigured.

Overridden from UActorComponent

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

OnComponentDestroyed ( bool bDestroyingHierarchy
)

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

Overridden from UObject

  Type Name Description
Protected function Virtual void  
Protected function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Protected function Virtual void Called after applying a transaction to the object.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void Called before applying a transaction to the object.

Constants

Name Description
DefaultSubdivisions  
MaxSubdivisions  
MESH_INDEX_ALL  
MESH_INDEX_NONE  
MESH_INDEX_PRIMARY  
MinSize2D  
MinSize3D  
MinSizeValue  
OnMaskDisabled  
OnMaskEnabled  
OnMaskVisibility  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page