Public Member Functions | |
UsdRiPxrRampLightFilter (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdRiPxrRampLightFilter on UsdPrim prim . More... | |
UsdRiPxrRampLightFilter (const UsdSchemaBase &schemaObj) | |
Construct a UsdRiPxrRampLightFilter on the prim held by schemaObj . More... | |
virtual USDRI_API | ~UsdRiPxrRampLightFilter () |
Destructor. More... | |
USDRI_API UsdAttribute | GetRampModeAttr () const |
Specifies the direction in which the ramp is applied. More... | |
USDRI_API UsdAttribute | CreateRampModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetRampModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetBeginDistanceAttr () const |
Distance where the ramp starts. More... | |
USDRI_API UsdAttribute | CreateBeginDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetBeginDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetEndDistanceAttr () const |
Distance where the ramp ends. More... | |
USDRI_API UsdAttribute | CreateEndDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetEndDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetFalloffAttr () const |
Controls the transition from the core to the edge. More... | |
USDRI_API UsdAttribute | CreateFalloffAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFalloffAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetFalloffKnotsAttr () const |
Knots of the falloff spline. More... | |
USDRI_API UsdAttribute | CreateFalloffKnotsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFalloffKnotsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetFalloffFloatsAttr () const |
Float values of the falloff spline. More... | |
USDRI_API UsdAttribute | CreateFalloffFloatsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFalloffFloatsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetFalloffInterpolationAttr () const |
Falloff spline type. More... | |
USDRI_API UsdAttribute | CreateFalloffInterpolationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFalloffInterpolationAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetColorRampAttr () const |
Controls the color gradient for the transition. More... | |
USDRI_API UsdAttribute | CreateColorRampAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetColorRampAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetColorRampKnotsAttr () const |
Knots of the colorRamp spline. More... | |
USDRI_API UsdAttribute | CreateColorRampKnotsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetColorRampKnotsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetColorRampColorsAttr () const |
Color values of the colorRamp spline. More... | |
USDRI_API UsdAttribute | CreateColorRampColorsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetColorRampColorsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdAttribute | GetColorRampInterpolationAttr () const |
ColorRamp spline type. More... | |
USDRI_API UsdAttribute | CreateColorRampInterpolationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetColorRampInterpolationAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDRI_API UsdRiSplineAPI | GetFalloffRampAPI () const |
Return the UsdRiSplineAPI interface used for examining and modifying the falloff ramp. More... | |
USDRI_API UsdRiSplineAPI | GetColorRampAPI () const |
Return the UsdRiSplineAPI interface used for examining and modifying the color ramp. More... | |
Public Member Functions inherited from UsdLuxLightFilter | |
UsdLuxLightFilter (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdLuxLightFilter on UsdPrim prim . More... | |
UsdLuxLightFilter (const UsdSchemaBase &schemaObj) | |
Construct a UsdLuxLightFilter on the prim held by schemaObj . More... | |
virtual USDLUX_API | ~UsdLuxLightFilter () |
Destructor. More... | |
USDLUX_API UsdCollectionAPI | GetFilterLinkCollectionAPI () const |
Return the UsdCollectionAPI interface used for examining and modifying the filter-linking of this light filter. More... | |
USDLUX_API | UsdLuxLightFilter (const UsdShadeConnectableAPI &connectable) |
Constructor that takes a ConnectableAPI object. More... | |
USDLUX_API UsdShadeConnectableAPI | ConnectableAPI () const |
Contructs and returns a UsdShadeConnectableAPI object with this light filter. More... | |
USDLUX_API UsdShadeOutput | CreateOutput (const TfToken &name, const SdfValueTypeName &typeName) |
Create an output which can either have a value or can be connected. More... | |
USDLUX_API UsdShadeOutput | GetOutput (const TfToken &name) const |
Return the requested output if it exists. More... | |
USDLUX_API std::vector < UsdShadeOutput > | GetOutputs (bool onlyAuthored=true) const |
Outputs are represented by attributes in the "outputs:" namespace. More... | |
USDLUX_API UsdShadeInput | CreateInput (const TfToken &name, const SdfValueTypeName &typeName) |
Create an input which can either have a value or can be connected. More... | |
USDLUX_API UsdShadeInput | GetInput (const TfToken &name) const |
Return the requested input if it exists. More... | |
USDLUX_API std::vector < UsdShadeInput > | GetInputs (bool onlyAuthored=true) const |
Inputs are represented by attributes in the "inputs:" namespace. More... | |
Public Member Functions inherited from UsdGeomXformable | |
UsdGeomXformable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomXformable on UsdPrim prim . More... | |
UsdGeomXformable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomXformable on the prim held by schemaObj . More... | |
virtual USDGEOM_API | ~UsdGeomXformable () |
Destructor. More... | |
USDGEOM_API UsdAttribute | GetXformOpOrderAttr () const |
Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage's prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims. More... | |
USDGEOM_API UsdAttribute | CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetXformOpOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDGEOM_API UsdGeomXformOp | AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add an affine transformation to the local stack represented by this Xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a translate operation to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a scale operation to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the X-axis to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the YX-axis to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the Z-axis to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with XYZ rotation order to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with XZY rotation order to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with YXZ rotation order to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with YZX rotation order to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with ZXY rotation order to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with ZYX rotation order to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a orient op (arbitrary axis/angle rotation) to the local stack represented by this xformable. More... | |
USDGEOM_API UsdGeomXformOp | AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a tranform op (4x4 matrix transformation) to the local stack represented by this xformable. More... | |
USDGEOM_API bool | SetResetXformStack (bool resetXform) const |
Specify whether this prim's transform should reset the transformation stack inherited from its parent prim. More... | |
USDGEOM_API bool | GetResetXformStack () const |
Does this prim reset its parent's inherited transformation? More... | |
USDGEOM_API bool | SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const |
Reorder the already-existing transform ops on this prim. More... | |
USDGEOM_API std::vector < UsdGeomXformOp > | GetOrderedXformOps (bool *resetsXformStack) const |
Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order. More... | |
USDGEOM_API bool | ClearXformOpOrder () const |
Clears the local transform stack. More... | |
USDGEOM_API UsdGeomXformOp | MakeMatrixXform () const |
Clears the existing local transform stack and creates a new xform op of type 'transform'. More... | |
USDGEOM_API bool | TransformMightBeTimeVarying () const |
Determine whether there is any possibility that this prim's local transformation may vary over time. More... | |
USDGEOM_API bool | TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Determine whether there is any possibility that this prim's local transformation may vary over time, using a pre-fetched (cached) list of ordered xform ops supplied by the client. More... | |
USDGEOM_API bool | GetTimeSamples (std::vector< double > *times) const |
Sets times to the union of all the timesamples at which xformOps that are included in the xformOpOrder attribute are authored. More... | |
USDGEOM_API bool | GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const |
Sets times to the union of all the timesamples in the interval, interval , at which xformOps that are included in the xformOpOrder attribute are authored. More... | |
USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const |
Computes the fully-combined, local-to-parent transformation for this prim. More... | |
USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the fully-combined, local-to-parent transformation for this prim as efficiently as possible, using a pre-fetched (cached) list of ordered xform ops supplied by the client. More... | |
Public Member Functions inherited from UsdGeomImageable | |
UsdGeomImageable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomImageable on UsdPrim prim . More... | |
UsdGeomImageable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomImageable on the prim held by schemaObj . More... | |
virtual USDGEOM_API | ~UsdGeomImageable () |
Destructor. More... | |
USDGEOM_API UsdAttribute | GetVisibilityAttr () const |
Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. More... | |
USDGEOM_API UsdAttribute | CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDGEOM_API UsdAttribute | GetPurposeAttr () const |
Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals. More... | |
USDGEOM_API UsdAttribute | CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDGEOM_API UsdRelationship | GetProxyPrimRel () const |
The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim. More... | |
USDGEOM_API UsdRelationship | CreateProxyPrimRel () const |
See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create. More... | |
USDGEOM_API void | MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
Make the imageable visible if it is invisible at the given time. More... | |
USDGEOM_API void | MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
Makes the imageable invisible if it is visible at the given time. More... | |
USDGEOM_API TfToken | ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const |
Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible" opinion, if any. More... | |
USDGEOM_API TfToken | ComputeVisibility (const TfToken &parentVisibility, UsdTimeCode const &time=UsdTimeCode::Default()) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective visibility of this prim, given the computed visibility of its parent prim at the given time . More... | |
USDGEOM_API PurposeInfo | ComputePurposeInfo () const |
Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions. More... | |
USDGEOM_API PurposeInfo | ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective purpose information about this prim, given the computed purpose information of its parent prim. More... | |
USDGEOM_API TfToken | ComputePurpose () const |
Calculate the effective purpose information about this prim. More... | |
USDGEOM_API UsdPrim | ComputeProxyPrim (UsdPrim *renderPrim=NULL) const |
Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the GetProxyPrimRel(), or an invalid UsdPrim if this prim has no proxy. More... | |
USDGEOM_API bool | SetProxyPrim (const UsdPrim &proxy) const |
Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim. More... | |
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 |
Compute the bound of this prim in world space, at the specified time , and for the specified purposes. More... | |
USDGEOM_API GfBBox3d | ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the bound of this prim in local space, at the specified time , and for the specified purposes. More... | |
USDGEOM_API GfBBox3d | ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the untransformed bound of this prim, at the specified time , and for the specified purposes. More... | |
USDGEOM_API GfMatrix4d | ComputeLocalToWorldTransform (UsdTimeCode const &time) const |
Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present. More... | |
USDGEOM_API GfMatrix4d | ComputeParentToWorldTransform (UsdTimeCode const &time) const |
Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself. More... | |
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()) | |
Construct a UsdTyped on UsdPrim prim . More... | |
UsdTyped (const UsdSchemaBase &schemaObj) | |
Construct a UsdTyped on the prim wrapped by schemaObj . More... | |
Public Member Functions inherited from UsdSchemaBase | |
bool | IsConcrete () const |
Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More... | |
bool | IsTyped () const |
Returns whether or not this class inherits from UsdTyped. More... | |
bool | IsAPISchema () const |
Returns whether this is an API schema or not. More... | |
bool | IsAppliedAPISchema () const |
Returns whether this is an applied API schema or not. More... | |
bool | IsMultipleApplyAPISchema () const |
Returns whether this is an applied API schema or not. More... | |
UsdSchemaKind | GetSchemaKind () const |
Returns the kind of schema this class is. More... | |
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 UsdPrimDefinition * | GetSchemaClassPrimDefinition () const |
Return the prim definition associated with this schema instance if one exists, otherwise return null. More... | |
Static Public Member Functions | |
static USDRI_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
static USDRI_API UsdRiPxrRampLightFilter | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdRiPxrRampLightFilter holding the prim adhering to this schema at path on stage . More... | |
static USDRI_API UsdRiPxrRampLightFilter | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More... | |
Static Public Member Functions inherited from UsdLuxLightFilter | |
static USDLUX_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
static USDLUX_API UsdLuxLightFilter | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdLuxLightFilter holding the prim adhering to this schema at path on stage . More... | |
static USDLUX_API UsdLuxLightFilter | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More... | |
Static Public Member Functions inherited from UsdGeomXformable | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
static USDGEOM_API UsdGeomXformable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomXformable holding the prim adhering to this schema at path on stage . More... | |
static USDGEOM_API bool | GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times) |
Returns the union of all the timesamples at which the attributes belonging to the given orderedXformOps are authored. More... | |
static USDGEOM_API bool | GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times) |
Returns the union of all the timesamples in the interval at which the attributes belonging to the given orderedXformOps are authored. More... | |
static USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is a static version of the preceding function that takes a cached list of ordered xform ops. More... | |
static USDGEOM_API bool | IsTransformationAffectedByAttrNamed (const TfToken &attrName) |
Returns true if the attribute named attrName could affect the local transformation of an xformable prim. More... | |
Static Public Member Functions inherited from UsdGeomImageable | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
static USDGEOM_API UsdGeomImageable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomImageable holding the prim adhering to this schema at path on stage . More... | |
static USDGEOM_API const TfTokenVector & | GetOrderedPurposeTokens () |
Returns an ordered list of allowed values of the purpose attribute. More... | |
Static Public Member Functions inherited from UsdTyped | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More... | |
static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdTyped holding the prim adhering to this schema at path on stage . More... | |
Static Public Member Functions inherited from UsdSchemaBase | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdLuxLightFilter | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdGeomXformable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdGeomImageable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdTyped | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdSchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
USDRI_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. More... | |
Protected Member Functions inherited from UsdTyped | |
USD_API bool | _IsCompatible () const override |
Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More... | |
Protected Member Functions inherited from UsdSchemaBase | |
virtual UsdSchemaKind | _GetSchemaType () const |
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 |
For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdRiTokens. So to set an attribute to the value "rightHanded", use UsdRiTokens->rightHanded as the value.
Definition at line 68 of file pxrRampLightFilter.h.
|
inlineexplicit |
Construct a UsdRiPxrRampLightFilter on UsdPrim prim
.
Equivalent to UsdRiPxrRampLightFilter::Get(prim.GetStage(), prim.GetPath()) for a valid prim
, but will not immediately throw an error for an invalid prim
Definition at line 80 of file pxrRampLightFilter.h.
|
inlineexplicit |
Construct a UsdRiPxrRampLightFilter on the prim held by schemaObj
.
Should be preferred over UsdRiPxrRampLightFilter(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 88 of file pxrRampLightFilter.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdLuxLightFilter.
USDRI_API UsdAttribute CreateBeginDistanceAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetBeginDistanceAttr(), and also Create vs Get Property Methods 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 CreateColorRampAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetColorRampAttr(), and also Create vs Get Property Methods 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 CreateColorRampColorsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetColorRampColorsAttr(), and also Create vs Get Property Methods 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 CreateColorRampInterpolationAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetColorRampInterpolationAttr(), and also Create vs Get Property Methods 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 CreateColorRampKnotsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetColorRampKnotsAttr(), and also Create vs Get Property Methods 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 CreateEndDistanceAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetEndDistanceAttr(), and also Create vs Get Property Methods 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 CreateFalloffAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFalloffAttr(), and also Create vs Get Property Methods 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 CreateFalloffFloatsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFalloffFloatsAttr(), and also Create vs Get Property Methods 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 CreateFalloffInterpolationAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFalloffInterpolationAttr(), and also Create vs Get Property Methods 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 CreateFalloffKnotsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFalloffKnotsAttr(), and also Create vs Get Property Methods 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 CreateRampModeAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetRampModeAttr(), and also Create vs Get Property Methods 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 |
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 |
Return a UsdRiPxrRampLightFilter 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:
USDRI_API UsdAttribute GetBeginDistanceAttr | ( | ) | const |
Distance where the ramp starts.
Declaration | float beginDistance = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdRiSplineAPI GetColorRampAPI | ( | ) | const |
Return the UsdRiSplineAPI interface used for examining and modifying the color ramp.
USDRI_API UsdAttribute GetColorRampAttr | ( | ) | const |
Controls the color gradient for the transition.
Declaration | int colorRamp = 4 |
C++ Type | int |
Usd Type | SdfValueTypeNames->Int |
USDRI_API UsdAttribute GetColorRampColorsAttr | ( | ) | const |
Color values of the colorRamp spline.
Declaration | color3f[] colorRamp:colors = [(1, 1, 1), (1, 1, 1), (1, 1, 1), (1, 1, 1)] |
C++ Type | VtArray<GfVec3f> |
Usd Type | SdfValueTypeNames->Color3fArray |
USDRI_API UsdAttribute GetColorRampInterpolationAttr | ( | ) | const |
ColorRamp spline type.
Declaration | token colorRamp:interpolation = "linear" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Allowed Values | linear, catmull-rom, bspline, constant |
USDRI_API UsdAttribute GetColorRampKnotsAttr | ( | ) | const |
Knots of the colorRamp spline.
Declaration | float[] colorRamp:knots = [0, 0, 1, 1] |
C++ Type | VtArray<float> |
Usd Type | SdfValueTypeNames->FloatArray |
USDRI_API UsdAttribute GetEndDistanceAttr | ( | ) | const |
Distance where the ramp ends.
Declaration | float endDistance = 10 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetFalloffAttr | ( | ) | const |
Controls the transition from the core to the edge.
Declaration | int falloff = 4 |
C++ Type | int |
Usd Type | SdfValueTypeNames->Int |
USDRI_API UsdAttribute GetFalloffFloatsAttr | ( | ) | const |
Float values of the falloff spline.
Declaration | float[] falloff:floats = [0, 0, 1, 1] |
C++ Type | VtArray<float> |
Usd Type | SdfValueTypeNames->FloatArray |
USDRI_API UsdAttribute GetFalloffInterpolationAttr | ( | ) | const |
Falloff spline type.
Declaration | token falloff:interpolation = "linear" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Allowed Values | linear, catmull-rom, bspline, constant |
USDRI_API UsdAttribute GetFalloffKnotsAttr | ( | ) | const |
Knots of the falloff spline.
Declaration | float[] falloff:knots = [0, 0, 1, 1] |
C++ Type | VtArray<float> |
Usd Type | SdfValueTypeNames->FloatArray |
USDRI_API UsdRiSplineAPI GetFalloffRampAPI | ( | ) | const |
Return the UsdRiSplineAPI interface used for examining and modifying the falloff ramp.
USDRI_API UsdAttribute GetRampModeAttr | ( | ) | const |
Specifies the direction in which the ramp is applied.
Declaration | token rampMode = "distanceToLight" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Allowed Values | distanceToLight, linear, spherical, radial |
|
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.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 74 of file pxrRampLightFilter.h.