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

#include <commandSettingsAPI.h>

+ Inheritance diagram for usdKarmaCommandSettingsAPI:

Public Member Functions

 usdKarmaCommandSettingsAPI (const UsdPrim &prim=UsdPrim())
 
 usdKarmaCommandSettingsAPI (const UsdSchemaBase &schemaObj)
 
virtual USDKARMA_API ~usdKarmaCommandSettingsAPI () override
 Destructor. More...
 
USDKARMA_API UsdAttribute GetKarmaCommandFrameAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCommandFrameAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCommandFrame_countAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCommandFrame_countAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCommandFrame_incAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCommandFrame_incAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCommandSnapshotAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCommandSnapshotAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCommandTimelimitAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCommandTimelimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCommandTimelimit_imageAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCommandTimelimit_imageAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCommandTimelimit_nosave_partialAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCommandTimelimit_nosave_partialAttr (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 USDKARMA_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDKARMA_API
usdKarmaCommandSettingsAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDKARMA_API
usdKarmaCommandSettingsAPI 
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

USDKARMA_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaType _GetSchemaType () const override
 
 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

Definition at line 56 of file commandSettingsAPI.h.

Constructor & Destructor Documentation

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

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

Definition at line 68 of file commandSettingsAPI.h.

usdKarmaCommandSettingsAPI::usdKarmaCommandSettingsAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 76 of file commandSettingsAPI.h.

usdKarmaCommandSettingsAPI::~usdKarmaCommandSettingsAPI ( )
overridevirtual

Destructor.

Definition at line 43 of file commandSettingsAPI.cpp.

Member Function Documentation

UsdSchemaType usdKarmaCommandSettingsAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

Definition at line 60 of file commandSettingsAPI.cpp.

usdKarmaCommandSettingsAPI usdKarmaCommandSettingsAPI::Apply ( const UsdPrim prim)
static

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

Returns
A valid usdKarmaCommandSettingsAPI object is returned upon success. An invalid (or empty) usdKarmaCommandSettingsAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

Definition at line 66 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::CreateKarmaCommandFrame_countAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCommandFrame_countAttr(), 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.

Definition at line 121 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::CreateKarmaCommandFrame_incAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCommandFrame_incAttr(), 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.

Definition at line 138 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::CreateKarmaCommandFrameAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCommandFrameAttr(), 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.

Definition at line 104 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::CreateKarmaCommandSnapshotAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCommandSnapshotAttr(), 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.

Definition at line 155 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::CreateKarmaCommandTimelimit_imageAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCommandTimelimit_imageAttr(), 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.

Definition at line 189 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::CreateKarmaCommandTimelimit_nosave_partialAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCommandTimelimit_nosave_partialAttr(), 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.

Definition at line 206 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::CreateKarmaCommandTimelimitAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCommandTimelimitAttr(), 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.

Definition at line 172 of file commandSettingsAPI.cpp.

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

Return a usdKarmaCommandSettingsAPI 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:

usdKarmaCommandSettingsAPI(stage->GetPrimAtPath(path));

Definition at line 49 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::GetKarmaCommandFrame_countAttr ( ) const

The number of frames to render.

Declaration int karma:command:frame_count = 1
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 115 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::GetKarmaCommandFrame_incAttr ( ) const

When rendering multiple frames (see frame_count), this specifies the frame increment for each subsequent frame.

Declaration float karma:command:frame_inc = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 132 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::GetKarmaCommandFrameAttr ( ) const

The start frame to render.

Declaration float karma:command:frame = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 98 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::GetKarmaCommandSnapshotAttr ( ) const

The time between snapshots of partial render results.

Declaration int karma:command:snapshot = -1
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 149 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::GetKarmaCommandTimelimit_imageAttr ( ) const

The render time limit is applied per image in a sequence rather than to the full render.

Declaration bool karma:command:timelimit_image = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 183 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::GetKarmaCommandTimelimit_nosave_partialAttr ( ) const

Normally, if the render time limit is exceeded, the partial image will be saved. If this option is disabled, a partial image will not be saved.

Declaration bool karma:command:timelimit_nosave_partial = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 200 of file commandSettingsAPI.cpp.

UsdAttribute usdKarmaCommandSettingsAPI::GetKarmaCommandTimelimitAttr ( ) const

Limit rendering to this number of seconds.

Declaration int karma:command:timelimit = -1
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 166 of file commandSettingsAPI.cpp.

const TfTokenVector & usdKarmaCommandSettingsAPI::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.

Definition at line 230 of file commandSettingsAPI.cpp.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 133 of file commandSettingsAPI.h.

Member Data Documentation

const UsdSchemaType usdKarmaCommandSettingsAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 62 of file commandSettingsAPI.h.


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