This class exposes methods for getting and setting primvar/channel mapping options.
More...
#include <PrimvarMappingOptions.h>
|
MaxUSDAPI | PrimvarMappingOptions () |
| Constructor.
|
|
MaxUSDAPI void | SetDefaultPrimvarChannelMappings () |
| Sets defaults primvar to channels mappings.
|
|
MaxUSDAPI const std::map< std::string, int > & | GetPrimvarMappings () const |
| Returns the primvar to channel map. More...
|
|
MaxUSDAPI void | SetPrimvarChannelMapping (const std::string &primvar, int channel) |
| Sets a primvar to channel mapping. More...
|
|
MaxUSDAPI int | GetPrimvarChannelMapping (const std::string &primvar) const |
| Gets the channel to which a primvar maps to. More...
|
|
MaxUSDAPI void | GetMappedPrimvars (std::vector< std::wstring > &primvars) const |
| Returns the list of all currently mapped primvars. More...
|
|
MaxUSDAPI bool | IsMappedPrimvar (const std::string &primvar) const |
| Checks if a primvar is currently mapped to a channel. More...
|
|
MaxUSDAPI bool | GetImportUnmappedPrimvars () const |
| Gets whether or not to import primvars that are not explicitely mapped. More...
|
|
MaxUSDAPI void | SetImportUnmappedPrimvars (bool importUnmappedPrimvars) |
| Sets whether or not to import primvars that are not explicitely mapped. If true, try to find the most appropriate channels for each unmapped primvar, based on their types. More...
|
|
MaxUSDAPI void | ClearMappedPrimvars () |
| Clears all primvar mappings.
|
|
|
static MaxUSDAPI const int | invalidChannel = INT_MIN |
|
|
std::map< std::string, int > | primvarToChannnelMappings |
|
bool | importUnmappedPrimvars = false |
|
This class exposes methods for getting and setting primvar/channel mapping options.
◆ GetImportUnmappedPrimvars()
MaxUSDAPI bool PrimvarMappingOptions::GetImportUnmappedPrimvars |
( |
| ) |
const |
Gets whether or not to import primvars that are not explicitely mapped.
- Returns
- True if unmapped primvars should be imported, false otherwise.
◆ GetMappedPrimvars()
MaxUSDAPI void PrimvarMappingOptions::GetMappedPrimvars |
( |
std::vector< std::wstring > & |
primvars | ) |
const |
Returns the list of all currently mapped primvars.
- Parameters
-
primvars | The vector of primvar names to be filled. |
◆ GetPrimvarChannelMapping()
MaxUSDAPI int PrimvarMappingOptions::GetPrimvarChannelMapping |
( |
const std::string & |
primvar | ) |
const |
Gets the channel to which a primvar maps to.
- Parameters
-
primvar | The name of the primvar for which to retrieve the target channel. |
- Returns
- The target channel for this primvar.
◆ GetPrimvarMappings()
MaxUSDAPI const std::map< std::string, int > & PrimvarMappingOptions::GetPrimvarMappings |
( |
| ) |
const |
Returns the primvar to channel map.
- Returns
- The mapping table.
◆ IsMappedPrimvar()
MaxUSDAPI bool PrimvarMappingOptions::IsMappedPrimvar |
( |
const std::string & |
primvar | ) |
const |
Checks if a primvar is currently mapped to a channel.
- Parameters
-
primvar | The primvar to check. |
- Returns
- True if the primvar is mapped, false otherwise.
◆ SetImportUnmappedPrimvars()
MaxUSDAPI void PrimvarMappingOptions::SetImportUnmappedPrimvars |
( |
bool |
importUnmappedPrimvars | ) |
|
Sets whether or not to import primvars that are not explicitely mapped. If true, try to find the most appropriate channels for each unmapped primvar, based on their types.
- Parameters
-
importUnmappedPrimvars | If true, unmapped primvars will be imported. |
◆ SetPrimvarChannelMapping()
MaxUSDAPI void PrimvarMappingOptions::SetPrimvarChannelMapping |
( |
const std::string & |
primvar, |
|
|
int |
channel |
|
) |
| |
Sets a primvar to channel mapping.
- Parameters
-
primvar | The name of the primvar. |
channel | The channel this primvar should be imported to. |
The documentation for this class was generated from the following file: