APEX NvParameterized Schemas: ClothingMaterialLibraryParameters Struct Reference

NVIDIA APEX

ClothingMaterialLibraryParameters Struct Reference

Describes the NxParameterized::Interface for 'ClothingMaterialLibraryParameters' : More...

#include <params.h>

List of all members.

Public Attributes

String materials[].materialName
 'materials[].materialName' : Material name
F32 materials[].verticalStretchingStiffness
 'materials[].verticalStretchingStiffness' : Vertical stretching stiffness of the cloth in the range (0, 1]. This parameter is ignored by the PhysX 2.8.4 solver.
F32 materials[].horizontalStretchingStiffness
 'materials[].horizontalStretchingStiffness' : Horizontal Stretching stiffness of the cloth in the range (0, 1].
F32 materials[].bendingStiffness
 'materials[].bendingStiffness' : Bending stiffness of the cloth in the range [0, 1].
F32 materials[].shearingStiffness
 'materials[].shearingStiffness' : Shearing stiffness of the cloth in the range [0, 1].
F32 materials[].tetherStiffness
 'materials[].tetherStiffness' : Range [0, 1], but should be 0. The higher this value, the more the piece of clothing is allowed to stretch.
F32 materials[].tetherLimit
 'materials[].tetherLimit' : Range [1, 4], but should be 1. This scales the restlength of the tether constraints.
Bool materials[].orthoBending
 'materials[].orthoBending' : Enable/disable orthogonal bending resistance.
F32 materials[].verticalStiffnessScaling.compressionRange
 'materials[].verticalStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.
F32 materials[].verticalStiffnessScaling.stretchRange
 'materials[].verticalStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.
F32 materials[].verticalStiffnessScaling.scale
 'materials[].verticalStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.
F32 materials[].horizontalStiffnessScaling.compressionRange
 'materials[].horizontalStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.
F32 materials[].horizontalStiffnessScaling.stretchRange
 'materials[].horizontalStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.
F32 materials[].horizontalStiffnessScaling.scale
 'materials[].horizontalStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.
F32 materials[].bendingStiffnessScaling.compressionRange
 'materials[].bendingStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.
F32 materials[].bendingStiffnessScaling.stretchRange
 'materials[].bendingStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.
F32 materials[].bendingStiffnessScaling.scale
 'materials[].bendingStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.
F32 materials[].shearingStiffnessScaling.compressionRange
 'materials[].shearingStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.
F32 materials[].shearingStiffnessScaling.stretchRange
 'materials[].shearingStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.
F32 materials[].shearingStiffnessScaling.scale
 'materials[].shearingStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.
F32 materials[].damping
 'materials[].damping' : Spring damping of the cloth in the range [0, 1]
F32 materials[].stiffnessFrequency
 'materials[].stiffnessFrequency' : Scales linearity of behavior for the varous stiffness values in the interval (0, 1)
F32 materials[].drag
 'materials[].drag' : Drag coefficient n the range [0, 1]
Bool materials[].comDamping
 'materials[].comDamping' : Enable/disable center of mass damping of internal velocities.
F32 materials[].friction
 'materials[].friction' : Friction coefficient in the range [0, 1]
F32 materials[].massScale
 'materials[].massScale' : Controls the amount of mass scaling during collision [0, 100]
U32 materials[].solverIterations
 'materials[].solverIterations' : Number of solver iterations. For 2.x cloth
F32 materials[].solverFrequency
 'materials[].solverFrequency' : Number of solver iterations per second. For 3.x cloth
F32 materials[].gravityScale
 'materials[].gravityScale' : Amount of gravity that is applied to the cloth.
F32 materials[].inertiaScale
 'materials[].inertiaScale' : Amount of inertia that is kept when using local space simulation.
F32 materials[].hardStretchLimitation
 'materials[].hardStretchLimitation' : Make cloth simulation less stretchy. A value smaller than 1 will turn it off.
F32 materials[].maxDistanceBias
 'materials[].maxDistanceBias' : Deform the max distance sphere into a capsule or a disc.
U32 materials[].hierarchicalSolverIterations
 'materials[].hierarchicalSolverIterations' : Number of iterations of the hierarchical cloth solver.
F32 materials[].selfcollisionThickness
 'materials[].selfcollisionThickness' : Minimal amount of distance particles will keep of each other.
F32 materials[].selfcollisionSquashScale
 'materials[].selfcollisionSquashScale' : Amount of thickness scaling along surface normal.
F32 materials[].selfcollisionStiffness
 'materials[].selfcollisionStiffness' : Stiffness of self collision solver.

Detailed Description

Describes the NxParameterized::Interface for 'ClothingMaterialLibraryParameters' :

ClothingMaterialLibraryParameters contains 37 fully qualified names
---------------------------------------------
  1 : ArraySizeName  materials                                                
  2 : String         materials[].materialName                                 
  3 : F32            materials[].verticalStretchingStiffness                  
  4 : F32            materials[].horizontalStretchingStiffness                
  5 : F32            materials[].bendingStiffness                             
  6 : F32            materials[].shearingStiffness                            
  7 : F32            materials[].tetherStiffness                              
  8 : F32            materials[].tetherLimit                                  
  9 : Bool           materials[].orthoBending                                 
 10 : F32            materials[].verticalStiffnessScaling.compressionRange    
 11 : F32            materials[].verticalStiffnessScaling.stretchRange        
 12 : F32            materials[].verticalStiffnessScaling.scale               
 13 : F32            materials[].horizontalStiffnessScaling.compressionRange  
 14 : F32            materials[].horizontalStiffnessScaling.stretchRange      
 15 : F32            materials[].horizontalStiffnessScaling.scale             
 16 : F32            materials[].bendingStiffnessScaling.compressionRange     
 17 : F32            materials[].bendingStiffnessScaling.stretchRange         
 18 : F32            materials[].bendingStiffnessScaling.scale                
 19 : F32            materials[].shearingStiffnessScaling.compressionRange    
 20 : F32            materials[].shearingStiffnessScaling.stretchRange        
 21 : F32            materials[].shearingStiffnessScaling.scale               
 22 : F32            materials[].damping                                      
 23 : F32            materials[].stiffnessFrequency                           
 24 : F32            materials[].drag                                         
 25 : Bool           materials[].comDamping                                   
 26 : F32            materials[].friction                                     
 27 : F32            materials[].massScale                                    
 28 : U32            materials[].solverIterations                             
 29 : F32            materials[].solverFrequency                              
 30 : F32            materials[].gravityScale                                 
 31 : F32            materials[].inertiaScale                                 
 32 : F32            materials[].hardStretchLimitation                        
 33 : F32            materials[].maxDistanceBias                              
 34 : U32            materials[].hierarchicalSolverIterations                 
 35 : F32            materials[].selfcollisionThickness                       
 36 : F32            materials[].selfcollisionSquashScale                     
 37 : F32            materials[].selfcollisionStiffness                       

Member Data Documentation

'materials[].bendingStiffness' : Bending stiffness of the cloth in the range [0, 1].

'materials[].bendingStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.

For any edge where the simulated length is within the range [restlength, compressionRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to compress more easily up to a certain limit.

'materials[].bendingStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.

'materials[].bendingStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.

For any edge where the simulated length is within the range [restlength, stretchRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to stretch more easily up to a certain limit.

'materials[].comDamping' : Enable/disable center of mass damping of internal velocities.

If set, the global rigid body modes (translation and rotation) are extracted from damping. This way, the cloth can freely move and rotate even under high damping.

'materials[].damping' : Spring damping of the cloth in the range [0, 1]

'materials[].drag' : Drag coefficient n the range [0, 1]

The drag coefficient is the portion of local frame velocity that is applied to each particle.

'materials[].friction' : Friction coefficient in the range [0, 1]

Currently only spheres and capsules impose friction on the colliding particles.

'materials[].gravityScale' : Amount of gravity that is applied to the cloth.

A value of 0 will make the cloth ignore gravity, a value of 10 will apply 10 times the gravity.

'materials[].hardStretchLimitation' : Make cloth simulation less stretchy. A value smaller than 1 will turn it off.

Good values are usually between 1 and 1.1. Any value >= 1 will guarantee that a certain set of edges is not longer than that value times the initial rest length.

'materials[].hierarchicalSolverIterations' : Number of iterations of the hierarchical cloth solver.

'materials[].horizontalStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.

For any edge where the simulated length is within the range [restlength, compressionRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to compress more easily up to a certain limit.

'materials[].horizontalStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.

'materials[].horizontalStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.

For any edge where the simulated length is within the range [restlength, stretchRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to stretch more easily up to a certain limit.

'materials[].horizontalStretchingStiffness' : Horizontal Stretching stiffness of the cloth in the range (0, 1].

'materials[].inertiaScale' : Amount of inertia that is kept when using local space simulation.

A value of 0 will make the cloth move in global space without inertia, a value of 1 will keep all inertia.

'materials[].massScale' : Controls the amount of mass scaling during collision [0, 100]

'materials[].materialName' : Material name

'materials[].maxDistanceBias' : Deform the max distance sphere into a capsule or a disc.

A value smaller than 0 will turn the sphere into a capsule and eventually a line (at value -1) along the normal of the vertex. A value bigger than 0 will turn the sphere into a disc.

'materials[].orthoBending' : Enable/disable orthogonal bending resistance.

Bending is modeled via an angular spring between adjacent triangles. This mode is slower but independent of stretching resistance.

'materials[].selfcollisionSquashScale' : Amount of thickness scaling along surface normal.

This feature prevents self collision thickness becoming too high for low resolution cloth.

'materials[].selfcollisionStiffness' : Stiffness of self collision solver.

This feature prevents meshes from self-intersecting. Only works properly when configured properly.

'materials[].selfcollisionThickness' : Minimal amount of distance particles will keep of each other.

This feature prevents meshes from self-intersecting. Only works properly when configured properly.

'materials[].shearingStiffness' : Shearing stiffness of the cloth in the range [0, 1].

'materials[].shearingStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.

For any edge where the simulated length is within the range [restlength, compressionRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to compress more easily up to a certain limit.

'materials[].shearingStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.

'materials[].shearingStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.

For any edge where the simulated length is within the range [restlength, stretchRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to stretch more easily up to a certain limit.

'materials[].solverFrequency' : Number of solver iterations per second. For 3.x cloth

Small numbers make the simulation faster while the cloth gets less stiff.

'materials[].solverIterations' : Number of solver iterations. For 2.x cloth

Small numbers make the simulation faster while the cloth gets less stiff.

'materials[].stiffnessFrequency' : Scales linearity of behavior for the varous stiffness values in the interval (0, 1)

'materials[].tetherLimit' : Range [1, 4], but should be 1. This scales the restlength of the tether constraints.

'materials[].tetherStiffness' : Range [0, 1], but should be 0. The higher this value, the more the piece of clothing is allowed to stretch.

'materials[].verticalStiffnessScaling.compressionRange' : Multiplier relative to rest length that defines where the stiffness is scaled down to allow compression.

For any edge where the simulated length is within the range [restlength, compressionRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to compress more easily up to a certain limit.

'materials[].verticalStiffnessScaling.scale' : Stiffness scale [0, 1] applied when inside the scaling range.

'materials[].verticalStiffnessScaling.stretchRange' : Multiplier relative to rest length that defines the range where the stiffness is scaled down to allow stretching.

For any edge where the simulated length is within the range [restlength, stretchRange*restlength], the scale will be multiplied on top of the regular stiffness. This is can be used to allow the cloth to stretch more easily up to a certain limit.

'materials[].verticalStretchingStiffness' : Vertical stretching stiffness of the cloth in the range (0, 1]. This parameter is ignored by the PhysX 2.8.4 solver.


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

Generated on Fri Dec 15 2017 13:59:11

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.