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 | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
NvCloth::Pipeline::ClothRule Class Reference

This class represents the data of a cloth rule (aka cloth modifier). More...

#include <ClothRule.h>

Inherits AZ::SceneAPI::DataTypes::IClothRule.

Public Member Functions

 AZ_RTTI (ClothRule, "{2F5AC324-314A-4C53-AFFF-DDFA46605DDB}", AZ::SceneAPI::DataTypes::IClothRule)
 
const AZStd::string & GetMeshNodeName () const override
 
AZStd::vector< AZ::Color > ExtractClothData (const AZ::SceneAPI::Containers::SceneGraph &graph, const size_t numVertices) const override
 
const AZStd::string & GetInverseMassesStreamName () const
 
const AZStd::string & GetMotionConstraintsStreamName () const
 
const AZStd::string & GetBackstopStreamName () const
 
void SetMeshNodeName (const AZStd::string &name)
 
void SetInverseMassesStreamName (const AZStd::string &name)
 
void SetMotionConstraintsStreamName (const AZStd::string &name)
 
void SetBackstopStreamName (const AZStd::string &name)
 
bool IsInverseMassesStreamDisabled () const
 
bool IsMotionConstraintsStreamDisabled () const
 
bool IsBackstopStreamDisabled () const
 
AZ::SceneAPI::DataTypes::ColorChannel GetInverseMassesStreamChannel () const
 
AZ::SceneAPI::DataTypes::ColorChannel GetMotionConstraintsStreamChannel () const
 
AZ::SceneAPI::DataTypes::ColorChannel GetBackstopOffsetStreamChannel () const
 
AZ::SceneAPI::DataTypes::ColorChannel GetBackstopRadiusStreamChannel () const
 
void SetInverseMassesStreamChannel (AZ::SceneAPI::DataTypes::ColorChannel channel)
 
void SetMotionConstraintsStreamChannel (AZ::SceneAPI::DataTypes::ColorChannel channel)
 
void SetBackstopOffsetStreamChannel (AZ::SceneAPI::DataTypes::ColorChannel channel)
 
void SetBackstopRadiusStreamChannel (AZ::SceneAPI::DataTypes::ColorChannel channel)
 

Static Public Member Functions

static AZ_CLASS_ALLOCATOR_DECL void Reflect (AZ::ReflectContext *context)
 
static bool VersionConverter (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement)
 

Static Public Attributes

static const char *const DefaultChooseNodeName
 
static const char *const DefaultInverseMassesString
 
static const char *const DefaultMotionConstraintsString
 
static const char *const DefaultBackstopString
 

Protected Member Functions

AZStd::shared_ptr< const AZ::SceneAPI::DataTypes::IMeshVertexColorData > FindVertexColorData (const AZ::SceneAPI::Containers::SceneGraph &graph, const AZ::SceneAPI::Containers::SceneGraph::NodeIndex &meshNodeIndex, const AZStd::string &vertexColorName, const size_t numVertices) const
 

Protected Attributes

AZStd::string m_meshNodeName
 
AZStd::string m_inverseMassesStreamName
 
AZStd::string m_motionConstraintsStreamName
 
AZStd::string m_backstopStreamName
 
AZ::SceneAPI::DataTypes::ColorChannel m_inverseMassesChannel = AZ::SceneAPI::DataTypes::ColorChannel::Red
 
AZ::SceneAPI::DataTypes::ColorChannel m_motionConstraintsChannel = AZ::SceneAPI::DataTypes::ColorChannel::Red
 
AZ::SceneAPI::DataTypes::ColorChannel m_backstopOffsetChannel = AZ::SceneAPI::DataTypes::ColorChannel::Red
 
AZ::SceneAPI::DataTypes::ColorChannel m_backstopRadiusChannel = AZ::SceneAPI::DataTypes::ColorChannel::Green
 

Detailed Description

This class represents the data of a cloth rule (aka cloth modifier).

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