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.
Public Member Functions | List of all members
NvCloth::ITangentSpaceHelper Class Referenceabstract

#include <ITangentSpaceHelper.h>

Public Member Functions

 AZ_RTTI (ITangentSpaceHelper, "{1D96A3F2-7EC7-4DD0-A874-7C2ED4D6F360}")
 
virtual bool CalculateNormals (const AZStd::vector< SimParticleFormat > &vertices, const AZStd::vector< SimIndexType > &indices, AZStd::vector< AZ::Vector3 > &outNormals)=0
 
virtual bool CalculateTangentsAndBitagents (const AZStd::vector< SimParticleFormat > &vertices, const AZStd::vector< SimIndexType > &indices, const AZStd::vector< SimUVType > &uvs, const AZStd::vector< AZ::Vector3 > &normals, AZStd::vector< AZ::Vector3 > &outTangents, AZStd::vector< AZ::Vector3 > &outBitangents)=0
 
virtual bool CalculateTangentSpace (const AZStd::vector< SimParticleFormat > &vertices, const AZStd::vector< SimIndexType > &indices, const AZStd::vector< SimUVType > &uvs, AZStd::vector< AZ::Vector3 > &outTangents, AZStd::vector< AZ::Vector3 > &outBitangents, AZStd::vector< AZ::Vector3 > &outNormals)=0
 

Detailed Description

Interface that provides a set of functions to calculate tangent space information for cloth's particles.

Note
Use AZ::Interface<ITangentSpaceHelper>::Get() to call the interface, which is available at both runtime and asset processing time (asset builders).

Member Function Documentation

◆ CalculateNormals()

virtual bool NvCloth::ITangentSpaceHelper::CalculateNormals ( const AZStd::vector< SimParticleFormat > &  vertices,
const AZStd::vector< SimIndexType > &  indices,
AZStd::vector< AZ::Vector3 > &  outNormals 
)
pure virtual

Calculates the normals of a simulation mesh.

Parameters
verticesList of particles, which are composed of positions and inverse masses.
indicesList of triangles' indices.
outNormalsThe resulted list of normals.
Returns
Whether it was able to calculate the normals or not.

◆ CalculateTangentsAndBitagents()

virtual bool NvCloth::ITangentSpaceHelper::CalculateTangentsAndBitagents ( const AZStd::vector< SimParticleFormat > &  vertices,
const AZStd::vector< SimIndexType > &  indices,
const AZStd::vector< SimUVType > &  uvs,
const AZStd::vector< AZ::Vector3 > &  normals,
AZStd::vector< AZ::Vector3 > &  outTangents,
AZStd::vector< AZ::Vector3 > &  outBitangents 
)
pure virtual

Calculates the tangents and bitangents of a simulation mesh.

Parameters
verticesList of particles, which are composed of positions and inverse masses.
indicesList of triangles' indices.
uvsList of UVs coordinates of the mesh.
normalsList of normals of the mesh.
outTangentsThe resulted list of tangents.
outBitangentsThe resulted list of bitangents.
Returns
Whether it was able to calculate the tangents and bitangents or not.

◆ CalculateTangentSpace()

virtual bool NvCloth::ITangentSpaceHelper::CalculateTangentSpace ( const AZStd::vector< SimParticleFormat > &  vertices,
const AZStd::vector< SimIndexType > &  indices,
const AZStd::vector< SimUVType > &  uvs,
AZStd::vector< AZ::Vector3 > &  outTangents,
AZStd::vector< AZ::Vector3 > &  outBitangents,
AZStd::vector< AZ::Vector3 > &  outNormals 
)
pure virtual

Calculates the tangents, bitangents and normals of a simulation mesh.

Parameters
verticesList of particles, which are composed of positions and inverse masses.
indicesList of triangles' indices.
uvsList of UVs coordinates of the mesh.
outTangentsThe resulted list of tangents.
outBitangentsThe resulted list of bitangents.
outNormalsThe resulted list of normals.
Returns
Whether it was able to calculate the tangents, bitangents and normals or not.
The documentation for this class was generated from the following file: