HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdRiTextureAPI Class Reference

#include <textureAPI.h>

+ Inheritance diagram for UsdRiTextureAPI:

Public Member Functions

 UsdRiTextureAPI (const UsdPrim &prim=UsdPrim())
 
 UsdRiTextureAPI (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiTextureAPI ()
 Destructor. More...
 
USDRI_API UsdAttribute GetRiTextureGammaAttr () const
 
USDRI_API UsdAttribute CreateRiTextureGammaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetRiTextureSaturationAttr () const
 
USDRI_API UsdAttribute CreateRiTextureSaturationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
UsdSchemaType GetSchemaType () const
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRI_API UsdRiTextureAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API UsdRiTextureAPI Apply (const UsdPrim &prim)
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 
const TfToken_GetInstanceName () const
 
USD_API bool _IsCompatible () const override
 
- Protected Member Functions inherited from UsdSchemaBase
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 

Detailed Description

Deprecated:
This API schema will be removed in a future release.

RiTextureAPI is an API schema that provides an interface to add Renderman-specific attributes to adjust textures.

Definition at line 61 of file textureAPI.h.

Constructor & Destructor Documentation

UsdRiTextureAPI::UsdRiTextureAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiTextureAPI on UsdPrim prim . Equivalent to UsdRiTextureAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 73 of file textureAPI.h.

UsdRiTextureAPI::UsdRiTextureAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiTextureAPI on the prim held by schemaObj . Should be preferred over UsdRiTextureAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 81 of file textureAPI.h.

virtual USDRI_API UsdRiTextureAPI::~UsdRiTextureAPI ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType UsdRiTextureAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiTextureAPI UsdRiTextureAPI::Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim. This information is stored by adding "RiTextureAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid UsdRiTextureAPI object is returned upon success. An invalid (or empty) UsdRiTextureAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
USDRI_API UsdAttribute UsdRiTextureAPI::CreateRiTextureGammaAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRiTextureGammaAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiTextureAPI::CreateRiTextureSaturationAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRiTextureSaturationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

static USDRI_API UsdRiTextureAPI UsdRiTextureAPI::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdRiTextureAPI holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdRiTextureAPI(stage->GetPrimAtPath(path));
USDRI_API UsdAttribute UsdRiTextureAPI::GetRiTextureGammaAttr ( ) const

Gamma-correct the texture

Declaration float ri:texture:gamma
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiTextureAPI::GetRiTextureSaturationAttr ( ) const

Adjust the texture's saturation

Declaration float ri:texture:saturation
C++ Type float
Usd Type SdfValueTypeNames->Float
static USDRI_API const TfTokenVector& UsdRiTextureAPI::GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 138 of file textureAPI.h.

Member Data Documentation

const UsdSchemaType UsdRiTextureAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaType

Definition at line 67 of file textureAPI.h.


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