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

#include <ClothRuleBehavior.h>

Inherits AZ::SceneAPI::SceneCore::BehaviorComponent, AZ::SceneAPI::Events::ManifestMetaInfoBus::Handler, and AZ::SceneAPI::Events::AssetImportRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (ClothRuleBehavior, "{00FA6C8A-27D2-4C0E-B601-6917950432E5}", AZ::SceneAPI::SceneCore::BehaviorComponent)
 
void Activate () override
 
void Deactivate () override
 
void GetAvailableModifiers (AZ::SceneAPI::Events::ManifestMetaInfo::ModifiersList &modifiers, const AZ::SceneAPI::Containers::Scene &scene, const AZ::SceneAPI::DataTypes::IManifestObject &target) override
 
void InitializeObject (const AZ::SceneAPI::Containers::Scene &scene, AZ::SceneAPI::DataTypes::IManifestObject &target) override
 
void GetPolicyName (AZStd::string &result) const override
 
AZ::SceneAPI::Events::ProcessingResult UpdateManifest (AZ::SceneAPI::Containers::Scene &scene, ManifestAction action, RequestingApplication requester) override
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

bool IsValidGroupType (const AZ::SceneAPI::DataTypes::ISceneNodeGroup &group) const
 
bool UpdateClothRules (AZ::SceneAPI::Containers::Scene &scene)
 
bool UpdateClothRule (const AZ::SceneAPI::Containers::SceneGraph &graph, const AZ::SceneAPI::DataTypes::ISceneNodeGroup &group, ClothRule &clothRule)
 
bool ContainsVertexColorStream (const AZ::SceneAPI::Containers::SceneGraph &graph, const AZStd::string &streamName) const
 

Detailed Description

This class defines the behavior of how to treat the cloth rule data through the SceneAPI. It specifies the valid Scene Groups that are allowed to have cloth rules (aka cloth modifiers), these are Mesh and Actor groups. It also validates the cloth rules data for the manifest (asset containing all the Scene information from the Scene Settings).

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