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

#include <cameraSettingsAPI.h>

+ Inheritance diagram for usdKarmaCameraSettingsAPI:

Public Member Functions

 usdKarmaCameraSettingsAPI (const UsdPrim &prim=UsdPrim())
 
 usdKarmaCameraSettingsAPI (const UsdSchemaBase &schemaObj)
 
virtual USDKARMA_API ~usdKarmaCameraSettingsAPI () override
 Destructor. More...
 
USDKARMA_API UsdAttribute GetKarmaCameraLensshadervopAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCameraLensshadervopAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCameraOrthowidthAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCameraOrthowidthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCameraUse_lensshaderAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCameraUse_lensshaderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaCameraWindowAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaCameraWindowAttr (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
usdKarmaCameraSettingsAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDKARMA_API
usdKarmaCameraSettingsAPI 
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 cameraSettingsAPI.h.

Constructor & Destructor Documentation

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

Construct a usdKarmaCameraSettingsAPI on UsdPrim prim . Equivalent to usdKarmaCameraSettingsAPI::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 cameraSettingsAPI.h.

usdKarmaCameraSettingsAPI::usdKarmaCameraSettingsAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 76 of file cameraSettingsAPI.h.

usdKarmaCameraSettingsAPI::~usdKarmaCameraSettingsAPI ( )
overridevirtual

Destructor.

Definition at line 43 of file cameraSettingsAPI.cpp.

Member Function Documentation

UsdSchemaType usdKarmaCameraSettingsAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

Definition at line 60 of file cameraSettingsAPI.cpp.

usdKarmaCameraSettingsAPI usdKarmaCameraSettingsAPI::Apply ( const UsdPrim prim)
static

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

Returns
A valid usdKarmaCameraSettingsAPI object is returned upon success. An invalid (or empty) usdKarmaCameraSettingsAPI 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 cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::CreateKarmaCameraLensshadervopAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCameraLensshadervopAttr(), 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 cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::CreateKarmaCameraOrthowidthAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCameraOrthowidthAttr(), 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 cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::CreateKarmaCameraUse_lensshaderAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCameraUse_lensshaderAttr(), 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 cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::CreateKarmaCameraWindowAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaCameraWindowAttr(), 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 cameraSettingsAPI.cpp.

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

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

usdKarmaCameraSettingsAPI(stage->GetPrimAtPath(path));

Definition at line 49 of file cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::GetKarmaCameraLensshadervopAttr ( ) const

Path to Lens Shader VOP.

Declaration string karma:camera:lensshadervop = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 98 of file cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::GetKarmaCameraOrthowidthAttr ( ) const

The width of the orthographic projection.

Declaration float karma:camera:orthowidth = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 115 of file cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::GetKarmaCameraUse_lensshaderAttr ( ) const

Toggle to override USD projection modes and use given CVEX lens shader.

Declaration bool karma:camera:use_lensshader = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 132 of file cameraSettingsAPI.cpp.

UsdAttribute usdKarmaCameraSettingsAPI::GetKarmaCameraWindowAttr ( ) const

The Screen Window specifies a window on the image projection. There are 4 values specifying the (xmin, xmax, ymin, ymax) values in NDC space of the image plane. This window is mapped to the full image. This provides the ability to do 2D pan and zoom on the screen projection.

Declaration float4 karma:camera:window = (-1, 1, -1, 1)
C++ Type GfVec4f
Usd Type SdfValueTypeNames->Float4

Definition at line 149 of file cameraSettingsAPI.cpp.

const TfTokenVector & usdKarmaCameraSettingsAPI::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 179 of file cameraSettingsAPI.cpp.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 133 of file cameraSettingsAPI.h.

Member Data Documentation

const UsdSchemaType usdKarmaCameraSettingsAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 62 of file cameraSettingsAPI.h.


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