Open 3D Engine NvCloth Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
NvCloth::ActorClothSkinning Class Referenceabstract

#include <ActorClothSkinning.h>

Classes

struct  NonSimulatedVertex
 
struct  SimulatedVertex
 

Public Member Functions

 AZ_TYPE_INFO (ActorClothSkinning, "{3E7C664D-096B-4126-8553-3241BA965533}")
 
 ActorClothSkinning (AZ::EntityId entityId)
 
virtual void UpdateSkinning ()=0
 Updates skinning with the current pose of the actor.
 
virtual void ApplySkinning (const AZStd::vector< AZ::Vector4 > &originalPositions, AZStd::vector< AZ::Vector4 > &positions)=0
 
virtual void ApplySkinningOnNonSimulatedVertices (const MeshClothInfo &originalData, ClothComponentMesh::RenderData &renderData)=0
 
void UpdateActorVisibility ()
 Updates visibility variables.
 
bool IsActorVisible () const
 Returns true if actor is currently visible on screen.
 
bool WasActorVisible () const
 Returns true if actor was visible on screen in previous update.
 

Static Public Member Functions

static AZStd::unique_ptr< ActorClothSkinning > Create (AZ::EntityId entityId, const MeshNodeInfo &meshNodeInfo, const AZStd::vector< SimParticleFormat > &originalMeshParticles, const size_t numSimulatedVertices, const AZStd::vector< int > &meshRemappedVertices)
 

Protected Attributes

AZ::EntityId m_entityId
 
AZStd::vector< SkinningInfluence > m_skinningInfluences
 
AZStd::vector< SimulatedVertex > m_simulatedVertices
 
AZStd::vector< NonSimulatedVertex > m_nonSimulatedVertices
 
AZStd::vector< AZ::u16 > m_jointIndices
 
bool m_wasActorVisible = false
 
bool m_isActorVisible = false
 

Detailed Description

Class to retrieve skinning information from an actor on the same entity and use that data to apply skinning to vertices.

Member Function Documentation

◆ ApplySkinning()

virtual void NvCloth::ActorClothSkinning::ApplySkinning ( const AZStd::vector< AZ::Vector4 > &  originalPositions,
AZStd::vector< AZ::Vector4 > &  positions 
)
pure virtual

Applies skinning to a list of positions.

Note
w components are not affected.

◆ ApplySkinningOnNonSimulatedVertices()

virtual void NvCloth::ActorClothSkinning::ApplySkinningOnNonSimulatedVertices ( const MeshClothInfo &  originalData,
ClothComponentMesh::RenderData &  renderData 
)
pure virtual

Applies skinning to a list of positions and vectors whose vertices have not been used for simulation.

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