UsdSkelBakeSkinningParms Struct Reference

Parameters for configuring UsdSkelBakeSkinning. More...

Public Types

enum  DeformationFlags {
  DeformPointsWithLBS = 1 << 0, DeformNormalsWithLBS = 1 << 1, DeformXformWithLBS = 1 << 2, DeformPointsWithBlendShapes = 1 << 3,
  DeformNormalsWithBlendShapes = 1 << 4, DeformWithLBS, DeformWithBlendShapes, DeformAll = DeformWithLBS|DeformWithBlendShapes,
  ModifiesPoints = DeformPointsWithLBS|DeformPointsWithBlendShapes, ModifiesNormals = DeformNormalsWithLBS|DeformNormalsWithBlendShapes, ModifiesXform = DeformXformWithLBS
}
 Flags for identifying different deformation paths. More...
 

Public Attributes

int deformationFlags = DeformAll
 Flags determining which deformation paths are enabled. More...
 
bool saveLayers = true
 Determines whether or not layers are saved during skinning. More...
 
size_t memoryLimit = 0
 Memory limit for pending stage writes, given in bytes. More...
 
bool updateExtents = true
 If true, extents of UsdGeomPointBased-derived prims are updated as new skinned values are produced. More...
 
bool updateExtentHints = true
 If true, extents hints of models that already stored an extentsHint are updated to reflect skinning changes. More...
 
std::vector< UsdSkelBindingbindings
 The set of bindings to bake. More...
 
std::vector< SdfLayerHandle > layers
 Data layers being written to. More...
 
VtUIntArray layerIndices
 Array providing an index per elem in bindings, indicating which layer the skinned result of the binding should be written to. More...
 

Detailed Description

Parameters for configuring UsdSkelBakeSkinning.

Definition at line 46 of file bakeSkinning.h.

Member Enumeration Documentation

◆ DeformationFlags

Flags for identifying different deformation paths.

Enumerator
ModifiesPoints 

Flags indicating which components of skinned prims may be modified, based on the active deformations.

Definition at line 49 of file bakeSkinning.h.

Member Data Documentation

◆ bindings

std::vector<UsdSkelBinding> bindings

The set of bindings to bake.

Definition at line 98 of file bakeSkinning.h.

◆ deformationFlags

int deformationFlags = DeformAll

Flags determining which deformation paths are enabled.

Definition at line 69 of file bakeSkinning.h.

◆ layerIndices

VtUIntArray layerIndices

Array providing an index per elem in bindings, indicating which layer the skinned result of the binding should be written to.

The length of this array must be equal to the length of the bindings array.

Definition at line 115 of file bakeSkinning.h.

◆ layers

std::vector<SdfLayerHandle> layers

Data layers being written to.

Layer authoring is not thread-safe, but if multiple layers are provided, then each of those layers may be written to on separate threads, improving parallelism of writes. Note that each layer must already be in the layer stack of the stage on which the bindings are defined before running baking. This is necessary in order for composition of some properties during the baking process. If this is not done, then extents of some models may be incorrect.

Definition at line 109 of file bakeSkinning.h.

◆ memoryLimit

size_t memoryLimit = 0

Memory limit for pending stage writes, given in bytes.

If zero, memory limits are ignored. Otherwise, output stages are flushed each time pending writes exceed this amount. Note that at least one frame of data for all skinned prims will be held in memory prior to values being written to disk, regardless of this memory limit.

Since flushing pending changes requires layers to be saved, memory limiting is only active when saveLayers is enabled.

Definition at line 84 of file bakeSkinning.h.

◆ saveLayers

bool saveLayers = true

Determines whether or not layers are saved during skinning.

If disabled, all skinning data is kept in-memory, and it is up to the caller to save or export the affected layers.

Definition at line 74 of file bakeSkinning.h.

◆ updateExtentHints

bool updateExtentHints = true

If true, extents hints of models that already stored an extentsHint are updated to reflect skinning changes.

All extent hints are authored to the stage's current edit target.

Definition at line 95 of file bakeSkinning.h.

◆ updateExtents

bool updateExtents = true

If true, extents of UsdGeomPointBased-derived prims are updated as new skinned values are produced.

This is made optional in case an alternate procedure is being used to compute extents elsewhere.

Definition at line 90 of file bakeSkinning.h.


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