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

#include <pxrEnvDayLight.h>

+ Inheritance diagram for UsdRiPxrEnvDayLight:

Public Member Functions

 UsdRiPxrEnvDayLight (const UsdPrim &prim=UsdPrim())
 
 UsdRiPxrEnvDayLight (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiPxrEnvDayLight ()
 Destructor. More...
 
USDRI_API UsdAttribute GetDayAttr () const
 
USDRI_API UsdAttribute CreateDayAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetHazinessAttr () const
 
USDRI_API UsdAttribute CreateHazinessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetHourAttr () const
 
USDRI_API UsdAttribute CreateHourAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetLatitudeAttr () const
 
USDRI_API UsdAttribute CreateLatitudeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetLongitudeAttr () const
 
USDRI_API UsdAttribute CreateLongitudeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetMonthAttr () const
 
USDRI_API UsdAttribute CreateMonthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetSkyTintAttr () const
 
USDRI_API UsdAttribute CreateSkyTintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetSunDirectionAttr () const
 
USDRI_API UsdAttribute CreateSunDirectionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetSunSizeAttr () const
 
USDRI_API UsdAttribute CreateSunSizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetSunTintAttr () const
 
USDRI_API UsdAttribute CreateSunTintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetYearAttr () const
 
USDRI_API UsdAttribute CreateYearAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetZoneAttr () const
 
USDRI_API UsdAttribute CreateZoneAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- Public Member Functions inherited from UsdLuxLight
 UsdLuxLight (const UsdPrim &prim=UsdPrim())
 
 UsdLuxLight (const UsdSchemaBase &schemaObj)
 
virtual USDLUX_API ~UsdLuxLight ()
 Destructor. More...
 
USDLUX_API UsdAttribute GetIntensityAttr () const
 
USDLUX_API UsdAttribute CreateIntensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdAttribute GetExposureAttr () const
 
USDLUX_API UsdAttribute CreateExposureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdAttribute GetDiffuseAttr () const
 
USDLUX_API UsdAttribute CreateDiffuseAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdAttribute GetSpecularAttr () const
 
USDLUX_API UsdAttribute CreateSpecularAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdAttribute GetNormalizeAttr () const
 
USDLUX_API UsdAttribute CreateNormalizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdAttribute GetColorAttr () const
 
USDLUX_API UsdAttribute CreateColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdAttribute GetEnableColorTemperatureAttr () const
 
USDLUX_API UsdAttribute CreateEnableColorTemperatureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdAttribute GetColorTemperatureAttr () const
 
USDLUX_API UsdAttribute CreateColorTemperatureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDLUX_API UsdRelationship GetFiltersRel () const
 
USDLUX_API UsdRelationship CreateFiltersRel () const
 
USDLUX_API GfVec3f ComputeBaseEmission () const
 
USDLUX_API UsdCollectionAPI GetLightLinkCollectionAPI () const
 
USDLUX_API UsdCollectionAPI GetShadowLinkCollectionAPI () const
 
- Public Member Functions inherited from UsdGeomXformable
 UsdGeomXformable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomXformable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomXformable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetXformOpOrderAttr () const
 
USDGEOM_API UsdAttribute CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdGeomXformOp AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API bool SetResetXformStack (bool resetXform) const
 
USDGEOM_API bool GetResetXformStack () const
 
USDGEOM_API bool SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
 
USDGEOM_API std::vector
< UsdGeomXformOp
GetOrderedXformOps (bool *resetsXformStack) const
 
USDGEOM_API bool ClearXformOpOrder () const
 Clears the local transform stack. More...
 
USDGEOM_API UsdGeomXformOp MakeMatrixXform () const
 
USDGEOM_API bool TransformMightBeTimeVarying () const
 
USDGEOM_API bool TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
 
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
 
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
 
- Public Member Functions inherited from UsdGeomImageable
 UsdGeomImageable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomImageable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomImageable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetVisibilityAttr () const
 
USDGEOM_API UsdAttribute CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetPurposeAttr () const
 
USDGEOM_API UsdAttribute CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdRelationship GetProxyPrimRel () const
 
USDGEOM_API UsdRelationship CreateProxyPrimRel () const
 
USDGEOM_API void MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API void MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (const TfToken &parentVisibility, UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API PurposeInfo ComputePurposeInfo () const
 
USDGEOM_API PurposeInfo ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
 
USDGEOM_API TfToken ComputePurpose () const
 
USDGEOM_API UsdPrim ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
 
USDGEOM_API bool SetProxyPrim (const UsdPrim &proxy) const
 
USDGEOM_API bool SetProxyPrim (const UsdSchemaBase &proxy) const
 
USDGEOM_API GfBBox3d ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API UsdGeomPrimvar CreatePrimvar (const TfToken &attrName, const SdfValueTypeName &typeName, const TfToken &interpolation=TfToken(), int elementSize=-1) const
 
USDGEOM_API UsdGeomPrimvar GetPrimvar (const TfToken &name) const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetPrimvars () const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetAuthoredPrimvars () const
 
USDGEOM_API bool HasPrimvar (const TfToken &name) const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- 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
UsdRiPxrEnvDayLight 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API
UsdRiPxrEnvDayLight 
Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdLuxLight
static USDLUX_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDLUX_API UsdLuxLight Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomXformable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API bool GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
 
static USDGEOM_API bool GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
 
static USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
 
static USDGEOM_API bool IsTransformationAffectedByAttrNamed (const TfToken &attrName)
 
- Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomImageable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API const
TfTokenVector
GetOrderedPurposeTokens ()
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdLuxLight
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 
- Static Public Attributes inherited from UsdTyped
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 UsdTyped
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
 

Detailed Description

Deprecated:
This schema will be replaced in a future release.

Definition at line 57 of file pxrEnvDayLight.h.

Constructor & Destructor Documentation

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

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

Definition at line 69 of file pxrEnvDayLight.h.

UsdRiPxrEnvDayLight::UsdRiPxrEnvDayLight ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 77 of file pxrEnvDayLight.h.

virtual USDRI_API UsdRiPxrEnvDayLight::~UsdRiPxrEnvDayLight ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType UsdRiPxrEnvDayLight::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdLuxLight.

USDRI_API UsdAttribute UsdRiPxrEnvDayLight::CreateDayAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetDayAttr(), 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 UsdRiPxrEnvDayLight::CreateHazinessAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetHazinessAttr(), 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 UsdRiPxrEnvDayLight::CreateHourAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetHourAttr(), 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 UsdRiPxrEnvDayLight::CreateLatitudeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetLatitudeAttr(), 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 UsdRiPxrEnvDayLight::CreateLongitudeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetLongitudeAttr(), 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 UsdRiPxrEnvDayLight::CreateMonthAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetMonthAttr(), 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 UsdRiPxrEnvDayLight::CreateSkyTintAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetSkyTintAttr(), 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 UsdRiPxrEnvDayLight::CreateSunDirectionAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetSunDirectionAttr(), 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 UsdRiPxrEnvDayLight::CreateSunSizeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetSunSizeAttr(), 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 UsdRiPxrEnvDayLight::CreateSunTintAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetSunTintAttr(), 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 UsdRiPxrEnvDayLight::CreateYearAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetYearAttr(), 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 UsdRiPxrEnvDayLight::CreateZoneAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetZoneAttr(), 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 UsdRiPxrEnvDayLight UsdRiPxrEnvDayLight::Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

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

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

UsdRiPxrEnvDayLight(stage->GetPrimAtPath(path));
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetDayAttr ( ) const

day: Day of the month, 1 through 31. This is ignored if month is 0.

Declaration int day = 1
C++ Type int
Usd Type SdfValueTypeNames->Int
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetHazinessAttr ( ) const

haziness: The turbidity of the sky. The lower limit of the model is 1.7 for an exceptionally clear sky, and 10, for an nversion, is the upper limit.

Declaration float haziness = 2
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetHourAttr ( ) const

hour: Hours since midnight, local standard time. May be fractional to include minutes and seconds. If daylight saving time is in effect, subtract 1 to correct to standard time. This is ignored if month is 0.

Declaration float hour = 14.633333
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetLatitudeAttr ( ) const

latitude: Latitude in degrees. Positive for north, negative for south. Ranges frmo -90 to +90 degrees. This is ignored if month is 0.

Declaration float latitude = 47.602
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetLongitudeAttr ( ) const

longitude: Longitude in degrees. Positive for east, negative for west. Ranges frmo -180 to +180 degrees. This is ignored if month is 0.

Declaration float longitude = -122.332
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetMonthAttr ( ) const

month: Month of the year, 1 through 12. The default, 0, means to use the explicitly given sun direction instead of automatically computing it.

Declaration int month = 0
C++ Type int
Usd Type SdfValueTypeNames->Int
static USDRI_API const TfTokenVector& UsdRiPxrEnvDayLight::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.

USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetSkyTintAttr ( ) const

skyTint: Tweak the sky's contribution and color. The default, white (1,1,1), gives results based on measured physical values.

Declaration color3f skyTint = (1, 1, 1)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Color3f
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetSunDirectionAttr ( ) const

sunDirection: The apparent direction towards the center of the sun. The zenith is at +Y (for noon light) and the horizon is in the XZ plane (for sunrise/set). Note that the Y component must non- negative. Ignored if a month is given.

Declaration vector3f sunDirection = (0, 0, 1)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Vector3f
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetSunSizeAttr ( ) const

sunSize: Scale the apparent size of the sun in the sky. Leave at 1 for a realistic sun size with an 0.55 degree angular diameter.

Declaration float sunSize = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetSunTintAttr ( ) const

sunTint: Tweak the sun's contribution and color. The default, white (1,1,1), gives results based on measured physical values. Setting this to black removes the sun contribution.

Declaration color3f sunTint = (1, 1, 1)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Color3f
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetYearAttr ( ) const

year: Four-digit year. This is ignored if month is 0.

Declaration int year = 2015
C++ Type int
Usd Type SdfValueTypeNames->Int
USDRI_API UsdAttribute UsdRiPxrEnvDayLight::GetZoneAttr ( ) const

zone: Standard time zone offset from GMT/UTC in hours. Positive for east, negative for west. For example, this would be -8 for Pacific time. This is ignored if month is 0.

Declaration float zone = -8
C++ Type float
Usd Type SdfValueTypeNames->Float

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 141 of file pxrEnvDayLight.h.

Member Data Documentation

const UsdSchemaType UsdRiPxrEnvDayLight::schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 63 of file pxrEnvDayLight.h.


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