FnUsdAbstractionLib  14.0.8
Public Member Functions | Static Public Member Functions | List of all members
usg::lux::DistantLightPrim Class Reference
Inheritance diagram for usg::lux::DistantLightPrim:
usg::lux::NonboundableLightBasePrim usg::LightPrim usg::XformablePrim usg::ImageablePrim usg::Prim

Public Member Functions

 DistantLightPrim (const Prim &prim)
 
bool validate ()
 
Relationship createFiltersRel ()
 
Relationship getFiltersRel () const
 
void setFilters (const PathArray &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
PathArray getFilters (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createAngleAttr (const Value &defaultValue=Value())
 
Attribute getAngleAttr () const
 
void setAngle (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getAngle (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createColorAttr (const Value &defaultValue=Value())
 
Attribute getColorAttr () const
 
void setColor (const fdk::Vec3f &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
fdk::Vec3f getColor (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createColorTemperatureAttr (const Value &defaultValue=Value())
 
Attribute getColorTemperatureAttr () const
 
void setColorTemperature (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getColorTemperature (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createDiffuseAttr (const Value &defaultValue=Value())
 
Attribute getDiffuseAttr () const
 
void setDiffuse (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getDiffuse (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createEnableColorTemperatureAttr (const Value &defaultValue=Value())
 
Attribute getEnableColorTemperatureAttr () const
 
void setEnableColorTemperature (bool value, fdk::TimeValue time=fdk::defaultTimeValue())
 
bool getEnableColorTemperature (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createExposureAttr (const Value &defaultValue=Value())
 
Attribute getExposureAttr () const
 
void setExposure (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getExposure (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createIntensityAttr (const Value &defaultValue=Value())
 
Attribute getIntensityAttr () const
 
void setIntensity (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getIntensity (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createNormalizeAttr (const Value &defaultValue=Value())
 
Attribute getNormalizeAttr () const
 
void setNormalize (bool value, fdk::TimeValue time=fdk::defaultTimeValue())
 
bool getNormalize (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createSpecularAttr (const Value &defaultValue=Value())
 
Attribute getSpecularAttr () const
 
void setSpecular (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getSpecular (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createShaderIdAttr (const Value &defaultValue=Value())
 
Attribute getShaderIdAttr () const
 
void setShaderId (const Token &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
Token getShaderId (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Relationship createProxyPrimRel ()
 
Relationship getProxyPrimRel () const
 
void setProxyPrim (const PathArray &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
PathArray getProxyPrim (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createPurposeAttr (const Value &defaultValue=Value())
 
Attribute getPurposeAttr () const
 
void setPurpose (const Token &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
Token getPurpose (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createVisibilityAttr (const Value &defaultValue=Value())
 
Attribute getVisibilityAttr () const
 
void setVisibility (const Token &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
Token getVisibility (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createXformOpOrderAttr (const Value &defaultValue=Value())
 
Attribute getXformOpOrderAttr () const
 
void setXformOpOrder (const TokenArray &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
TokenArray getXformOpOrder (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
CollectionAPI getLightLink () const
 
CollectionAPI getShadowLink () const
 
- Public Member Functions inherited from usg::lux::NonboundableLightBasePrim
 NonboundableLightBasePrim (const Prim &prim)
 
bool validate ()
 
- Public Member Functions inherited from usg::LightPrim
 LightPrim ()
 Default ctor builds an empty (invalid) prim.
 
 LightPrim (const Prim &)
 Does not test if castable to LightPrim!
 
 LightPrim (const LightPrim &)
 Copy constructors.
 
 LightPrim (const Prim::Impl &)
 
virtual ~LightPrim ()
 Dtor in implementation required for std::unique_ptr to work.
 
ShaderDesc * createShaderDesc (const fdk::TimeValue &time=fdk::defaultTimeValue()) const
 
Attribute createColorAttr (const Value &defaultValue=Value())
 
Attribute getColorAttr () const
 
void setColor (const fdk::Vec3f &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
fdk::Vec3f getColor (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createColorTemperatureAttr (const Value &defaultValue=Value())
 
Attribute getColorTemperatureAttr () const
 
void setColorTemperature (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getColorTemperature (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createDiffuseAttr (const Value &defaultValue=Value())
 
Attribute getDiffuseAttr () const
 
void setDiffuse (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getDiffuse (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createEnableColorTemperatureAttr (const Value &defaultValue=Value())
 
Attribute getEnableColorTemperatureAttr () const
 
void setEnableColorTemperature (bool value, fdk::TimeValue time=fdk::defaultTimeValue())
 
bool getEnableColorTemperature (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createExposureAttr (const Value &defaultValue=Value())
 
Attribute getExposureAttr () const
 
void setExposure (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getExposure (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createIntensityAttr (const Value &defaultValue=Value())
 
Attribute getIntensityAttr () const
 
void setIntensity (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getIntensity (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createNormalizeAttr (const Value &defaultValue=Value())
 
Attribute getNormalizeAttr () const
 
void setNormalize (bool value, fdk::TimeValue time=fdk::defaultTimeValue())
 
bool getNormalize (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createSpecularAttr (const Value &defaultValue=Value())
 
Attribute getSpecularAttr () const
 
void setSpecular (float value, fdk::TimeValue time=fdk::defaultTimeValue())
 
float getSpecular (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Relationship createFiltersRel ()
 
Relationship getFiltersRel () const
 
void setFilters (const PathArray &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
PathArray getFilters (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
- Public Member Functions inherited from usg::XformablePrim
 XformablePrim (const Prim &prim)
 
Attribute createXformOpOrderAttr (const Value &defaultValue=Value())
 
Attribute getXformOpOrderAttr () const
 
void setXformOpOrder (const TokenArray &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
TokenArray getXformOpOrder (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
fdk::Mat4d getLocalXform (const fdk::TimeValue &time=fdk::defaultTimeValue()) const
 Retrieves the local transform of this Prim.
 
fdk::Mat4d getConcatenatedXform (const fdk::TimeValue &time=fdk::defaultTimeValue()) const
 Retrieves the concatenated transform at this Prim (includes parents.)
 
bool getTimeSamples (fdk::TimeValueList &times) const
 Retrieve the union of the time samples for all assigned XformOps.
 
void setXformTo (const std::string &id_name, const fdk::Mat4d &xform, const fdk::TimeValue &time=fdk::defaultTimeValue())
 
void addXformOp (const std::string &id_name, const fdk::Mat4d &xform, const fdk::TimeValue &time, bool prepend=false)
 
void clearAllXformOps ()
 Removes all xform ops in this prim.
 
fdk::StringList getOrderedXformOps () const
 Retrieves the name of the ordered xformOps.
 
void copyXformOps (const XformablePrim &xformable, fdk::TimeValue time)
 Copies the xformOps from the other xformable prim.
 
- Public Member Functions inherited from usg::ImageablePrim
 ImageablePrim (const Prim &prim)
 
Relationship createProxyPrimRel ()
 
Relationship getProxyPrimRel () const
 
void setProxyPrim (const PathArray &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
PathArray getProxyPrim (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createPurposeAttr (const Value &defaultValue=Value())
 
Attribute getPurposeAttr () const
 
void setPurpose (const Token &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
Token getPurpose (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
Attribute createVisibilityAttr (const Value &defaultValue=Value())
 
Attribute getVisibilityAttr () const
 
void setVisibility (const Token &value, fdk::TimeValue time=fdk::defaultTimeValue())
 
Token getVisibility (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
- Public Member Functions inherited from usg::Prim
 Prim ()
 Abstraction handle for casting to UsdPrim. More...
 
 Prim (const Prim &)
 
 Prim (const Prim::Impl &)
 
Prim & operator= (const Prim &)
 
bool operator== (const Prim &b) const
 Equality - are the two Prims the same object or not? Compares the underlying Prim::Impls.
 
bool operator!= (const Prim &b) const
 
bool operator< (const Prim &b) const
 
bool isValid () const
 Returns true if Prim::Impl is valid (has a valid object binding.)
 
 operator bool () const
 
class Prim::SpecPrimHandle * getSdfPrimSpec (int usd_version)
 
const class Prim::SpecPrimHandle * getSdfPrimSpec (int usd_version) const
 
class Prim::UsdPrimHandle * getUsdPrim (int usd_version)
 
const class Prim::UsdPrimHandle * getUsdPrim (int usd_version) const
 
const std::string & getName () const
 Returns the name of the prim.
 
Path getPath () const
 Returns the path of the prim.
 
const Token getTypeName () const
 Returns the name of the type of the prim.
 
Prim getParent () const
 Return this prim's parent prim. Returns an invalid prim if this is a root prim.
 
bool isPseudoRoot () const
 Returns true if the prim is the pseudo root - ie '/'.
 
bool isA (const Token &typeName) const
 Returns true if the prim is an instance of the given type.
 
template<class T >
bool isA () const
 Returns true if the prim is an instance of a schema.
 
bool hasApi (const Token &typeName) const
 Returns true if the prim has the given API.
 
bool hasApi (const Token &typeName, const Token &instanceName) const
 Returns true if the prim has the given multiple-apply schema API.
 
template<class T >
bool hasApi () const
 Returns true if the prim has the given API.
 
template<class T >
bool hasApi (const Token &instanceName) const
 Returns true if the prim has the given multiple-apply schema API.
 
void setActive (bool active)
 
bool isActive () const
 
bool isDefined () const
 
bool hasPayload () const
 
bool isLoaded () const
 
void load () const
 
void unload () const
 
void setVisible (bool active, fdk::TimeValue time=fdk::defaultTimeValue())
 
bool isVisible (fdk::TimeValue time=fdk::defaultTimeValue()) const
 
bool addAppliedSchema (const Token &schemaName)
 
void setCreator (const Token &creator)
 Sets the name of the app that created this prim.
 
Token creatorApp () const
 Gets the name of the app that created this prim.
 
bool isCreator (const Token &creator) const
 True if creator is the prim's creator app.
 
void setCustomData (const std::string &key, const Value &value)
 Sets the custom data value of given key.
 
bool getCustomData (const std::string &key, Value &value) const
 Retrieves the custom data value for the key. Returns true if it exists.
 
Value getCustomData (const std::string &key) const
 Returns a valid value if the custom data exists for the key.
 
bool hasCustomData (const std::string &key) const
 Checks whether the prim has custom data for the key.
 
void removeCustomData (const std::string &key)
 Erases the custom data for the key.
 
void setKind (const Token &kind)
 
Token getKind () const
 
void setInstanceable (bool instanceable)
 
bool isInstanceable () const
 
Attribute createIntrinsicAttr (const Token &name, Value::Type type, TimeVariability variability_hint=TimeVariability::Uniform)
 
Attribute createCustomAttr (const Token &name, Value::Type type, TimeVariability variability_hint=TimeVariability::Uniform)
 
Attribute createAttr (const Token &name, Value::Type type, bool is_custom=false, TimeVariability variability_hint=TimeVariability::Varying, const Value &defaultValue=Value())
 
template<typename T >
Attribute setAttr (const Token &name, const T &v, const fdk::TimeValue &time=fdk::defaultTimeValue())
 
Attribute getAttr (const Token &name) const
 If the named attribute exists on the Prim returns it otherwise return an empty (invalid) Attribute object.
 
bool getAttr (const Token &name, Attribute &attr) const
 
std::vector< Token > getAttributes () const
 Returns the list of attributes.
 
Attribute copyAttr (const Prim &fromPrim, const Token &name, fdk::TimeValue time)
 Copy the attribute from another prim at the given time.
 
virtual bool applyAttributeOverrides (const ShaderDesc &schema_desc, bool skip_connected=true)
 
Relationship createRelationship (const Token &name, bool custom=false)
 Creates and returns an empty relationship.
 
Relationship getRelationship (const Token &name) const
 
bool getRelationship (const Token &name, Relationship &rel) const
 
size_t getRelationships (std::vector< const char * > &relationships) const
 Fills in the list of relationship names, returning the number of relationship.
 
void addReference (const std::string &identifier, const Path &path, ListPosition position=ListPosition::PrependBack)
 Adds a reference to the prim's reference list.
 
void addPayload (const std::string &identifier, const Path &path, ListPosition position=ListPosition::PrependBack)
 Adds a payload to the prim's reference list.
 
void addVariantSet (const std::string &variantSetName, ListPosition position=ListPosition::PrependBack)
 Adds a variant set to the prim.
 
void addVariant (const std::string &variantSetName, const std::string &variantName)
 Adds a variant to a variant set.
 
void setVariantSelection (const std::string &variantSetName, const std::string &selection)
 Sets the variant selection for a variant set.
 
std::vector< std::string > getVariantSets () const
 Returns the list of variant sets authored on the prim.
 
std::vector< std::string > getVariants (const std::string &variantSetName) const
 Returns the list of variants for a variant set on this prim.
 
size_t getChildren (std::vector< Prim > &children, bool activeOnly=true) const
 
LayerRef getDefiningLayer () const
 Returns a possible layer which defined this prim. This returns the layer containing the first "def" for the prim.
 
virtual void print (const char *prefix, std::ostream &o) const
 Debugging - prints some key info about the prim to a stream.
 
Prim::Impl * impl ()
 
const Prim::Impl * impl () const
 

Static Public Member Functions

static bool isValidPrim (const Prim &prim)
 
static DistantLightPrim defineInLayer (const LayerRef &layer, const Path &path)
 
static DistantLightPrim overrideInLayer (const LayerRef &layer, const Prim &prim)
 
static DistantLightPrim getInStage (const StageRef &stage, const Path &path)
 
- Static Public Member Functions inherited from usg::lux::NonboundableLightBasePrim
static bool isValidPrim (const Prim &prim)
 
static NonboundableLightBasePrim overrideInLayer (const LayerRef &layer, const Prim &prim)
 
static NonboundableLightBasePrim getInStage (const StageRef &stage, const Path &path)
 
- Static Public Member Functions inherited from usg::LightPrim
static bool isValidPrim (const Prim &prim)
 Returns true if prim is a LightPrim subclass.
 
- Static Public Member Functions inherited from usg::XformablePrim
static bool isValidPrim (const Prim &prim)
 
static XformablePrim overrideInLayer (const LayerRef &layer, const Prim &prim)
 
static XformablePrim getInStage (const StageRef &stage, const Path &path)
 
static std::string getXformOpAttrName (const std::string &idName)
 
static bool canConcatenateTransform (const Prim &prim)
 Return true if prim can concatenate its transform (valid XformablePrim or ScopePrim.)
 
static size_t getConcatenatedXformOpTimeSamples (const Prim &prim, fdk::TimeValueSet &times)
 Find the total first-last keyframe range for the prim and all its concatenable parents.
 
static fdk::Mat4d getLocalMatrixAtPrim (const Prim &prim, const fdk::TimeValue &time)
 Return the local transform matrix for the prim, if valid, otherwise the identity.
 
static fdk::Mat4d getConcatenatedMatrixAtPrim (const Prim &prim, const fdk::TimeValue &time)
 Return the concatenated world transform matrix for the prim, if valid, otherwise the identity.
 
static void getConcatenatedMatricesAtPrim (const Prim &prim, const fdk::TimeValueList &times, usg::Mat4dArray &matrices)
 Return the concatenated world transform matrices for the prim at specific times, if valid, otherwise the array is empty.
 
- Static Public Member Functions inherited from usg::ImageablePrim
static bool isValidPrim (const Prim &prim)
 
static ImageablePrim overrideInLayer (const LayerRef &layer, const Prim &prim)
 
static ImageablePrim getInStage (const StageRef &stage, const Path &path)
 
- Static Public Member Functions inherited from usg::Prim
static Prim defineInLayer (const LayerRef &layer, const Path &path, const Token &typeName)
 
static Prim overrideInLayer (const LayerRef &layer, const Path &path, const Token &typeName)
 
static void createMissingParents (const StageRef &referenceStage, const LayerRef &layer, const Path &path, const Token &parentPrimType=GeomTokens.types.Scope)
 

Additional Inherited Members

- Protected Attributes inherited from usg::Prim
std::unique_ptr< Prim::Impl > _pImpl
 

Member Function Documentation

bool usg::lux::DistantLightPrim::validate ( )
virtual

Call this after construction to validate this Prim as a LightPrim type, returning true if it's still valid. If not the Prim::Impl will be invalidated and isValid() will then return false.

Reimplemented from usg::LightPrim.


©2024 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.foundry.com