UsdColorSpaceDefinitionAPI is an API schema for defining a custom color space. More...

#include <colorSpaceDefinitionAPI.h>

Inheritance diagram for UsdColorSpaceDefinitionAPI:

Public Member Functions
	UsdColorSpaceDefinitionAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a UsdColorSpaceDefinitionAPI on UsdPrim `prim` with name `name` .

	UsdColorSpaceDefinitionAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a UsdColorSpaceDefinitionAPI on the prim held by `schemaObj` with name `name`.

virtual USD_API	~UsdColorSpaceDefinitionAPI ()
	Destructor.

TfToken	GetName () const
	Returns the name of this multiple-apply schema instance.

USD_API UsdAttribute	GetNameAttr () const
	The name of the color space defined on this prim.

USD_API UsdAttribute	CreateNameAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USD_API UsdAttribute	GetRedChromaAttr () const
	Red chromaticity coordinates.

USD_API UsdAttribute	CreateRedChromaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetRedChromaAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USD_API UsdAttribute	GetGreenChromaAttr () const
	Green chromaticity coordinates.

USD_API UsdAttribute	CreateGreenChromaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGreenChromaAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USD_API UsdAttribute	GetBlueChromaAttr () const
	Blue chromaticity coordinates.

USD_API UsdAttribute	CreateBlueChromaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBlueChromaAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USD_API UsdAttribute	GetWhitePointAttr () const
	Whitepoint chromaticity coordinates.

USD_API UsdAttribute	CreateWhitePointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetWhitePointAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USD_API UsdAttribute	GetGammaAttr () const
	Gamma value of the log section.

USD_API UsdAttribute	CreateGammaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetGammaAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USD_API UsdAttribute	GetLinearBiasAttr () const
	Linear bias of the log section.

USD_API UsdAttribute	CreateLinearBiasAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLinearBiasAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USD_API void	CreateColorSpaceAttrsWithChroma (const GfVec2f &redChroma, const GfVec2f &greenChroma, const GfVec2f &blueChroma, const GfVec2f &whitePoint, float gamma, float linearBias)
	Creates the color space attributes with the given values.

USD_API void	CreateColorSpaceAttrsWithMatrix (const GfMatrix3f &rgbToXYZ, float gamma, float linearBias)
	Create the color space attributes by deriving the color space from the given RGB to XYZ matrix and linearization parameters.

USD_API GfColorSpace	ComputeColorSpaceFromDefinitionAttributes () const
	Create a `GfColorSpace` object from the color space definition attributes.

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim `prim` .

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by `schemaObj` .

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

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.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

bool	IsAPISchema () const
	Returns whether this is an API schema or not.

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim.

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`.

virtual USD_API	~UsdSchemaBase ()
	Destructor.

UsdPrim	GetPrim () const
	Return this schema object's held prim.

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
static USD_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.

static USD_API TfTokenVector	GetSchemaAttributeNames (bool includeInherited, const TfToken &instanceName)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.

static USD_API UsdColorSpaceDefinitionAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdColorSpaceDefinitionAPI holding the prim adhering to this schema at `path` on `stage`.

static USD_API UsdColorSpaceDefinitionAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a UsdColorSpaceDefinitionAPI with name `name` holding the prim `prim`.

static USD_API std::vector< UsdColorSpaceDefinitionAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of UsdColorSpaceDefinitionAPI on the given `prim`.

static USD_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)
	Checks if the given name `baseName` is the base name of a property of ColorSpaceDefinitionAPI.

static USD_API bool	IsColorSpaceDefinitionAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path `path` is of an API schema of type ColorSpaceDefinitionAPI.

static USD_API bool	CanApply (const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)
	Returns true if this multiple-apply API schema can be applied, with the given instance name, `name`, to the given `prim`.

static USD_API UsdColorSpaceDefinitionAPI	Apply (const UsdPrim &prim, const TfToken &name)
	Applies this multiple-apply API schema to the given `prim` along with the given instance name, `name`.

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_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.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::MultipleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

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

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

Detailed Description

UsdColorSpaceDefinitionAPI is an API schema for defining a custom color space.

Custom color spaces become available for use on prims or for assignment to attributes via the colorSpace:name property on prims that have applied UsdColorSpaceAPI. Since color spaces inherit hierarchically, a custom color space defined on a prim will be available to all descendants of that prim, unless overridden by a more local color space definition bearing the same name. Locally redefining color spaces within the same layer could be confusing, so that practice is discouraged.

The default color space values are equivalent to an identity transform, so applying this schema and invoking UsdColorSpaceAPI::ComputeColorSpace() on a prim resolving to a defaulted color definition will return a color space equivalent to the identity transform.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdTokens. So to set an attribute to the value "rightHanded", use UsdTokens->rightHanded as the value.

Definition at line 61 of file colorSpaceDefinitionAPI.h.

Constructor & Destructor Documentation

◆ UsdColorSpaceDefinitionAPI() [1/2]

UsdColorSpaceDefinitionAPI	(	const UsdPrim &	prim = `UsdPrim()`,
		const TfToken &	name = `TfToken()`
	)

inlineexplicit

Construct a UsdColorSpaceDefinitionAPI on UsdPrim prim with name name .

Equivalent to UsdColorSpaceDefinitionAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "colorSpaceDefinition:name"));

for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 78 of file colorSpaceDefinitionAPI.h.

◆ UsdColorSpaceDefinitionAPI() [2/2]

UsdColorSpaceDefinitionAPI	(	const UsdSchemaBase &	schemaObj,
		const TfToken &	name
	)

inlineexplicit

Construct a UsdColorSpaceDefinitionAPI on the prim held by schemaObj with name name.

Should be preferred over UsdColorSpaceDefinitionAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

Definition at line 87 of file colorSpaceDefinitionAPI.h.

◆ ~UsdColorSpaceDefinitionAPI()

virtual USD_API ~UsdColorSpaceDefinitionAPI ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USD_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USD_API UsdColorSpaceDefinitionAPI Apply	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding "ColorSpaceDefinitionAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'ColorSpaceDefinitionAPI:instance1' is added to 'apiSchemas'.

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

See also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ CanApply()

static USD_API bool CanApply	(	const UsdPrim &	prim,
		const TfToken &	name,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim.

If this schema can not be a applied the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ ComputeColorSpaceFromDefinitionAttributes()

USD_API GfColorSpace ComputeColorSpaceFromDefinitionAttributes ( ) const

Create a GfColorSpace object from the color space definition attributes.

◆ CreateBlueChromaAttr()

USD_API UsdAttribute CreateBlueChromaAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

◆ CreateColorSpaceAttrsWithChroma()

USD_API void CreateColorSpaceAttrsWithChroma	(	const GfVec2f &	redChroma,
		const GfVec2f &	greenChroma,
		const GfVec2f &	blueChroma,
		const GfVec2f &	whitePoint,
		float	gamma,
		float	linearBias
	)

Creates the color space attributes with the given values.

Parameters

redChroma	The red chromaticity coordinates.
greenChroma	The green chromaticity coordinates.
blueChroma	The blue chromaticity coordinates.
whitePoint	The whitepoint chromaticity coordinates.
gamma	The gamma value of the log section.
linearBias	The linear bias of the log section.

◆ CreateColorSpaceAttrsWithMatrix()

USD_API void CreateColorSpaceAttrsWithMatrix	(	const GfMatrix3f &	rgbToXYZ,
		float	gamma,
		float	linearBias
	)

Create the color space attributes by deriving the color space from the given RGB to XYZ matrix and linearization parameters.

Parameters

rgbToXYZ	The RGB to XYZ matrix.
gamma	The gamma value of the log section.
linearBias	The linear bias of the log section.

◆ CreateGammaAttr()

USD_API UsdAttribute CreateGammaAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

◆ CreateGreenChromaAttr()

USD_API UsdAttribute CreateGreenChromaAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

◆ CreateLinearBiasAttr()

USD_API UsdAttribute CreateLinearBiasAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

◆ CreateNameAttr()

USD_API UsdAttribute CreateNameAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

◆ CreateRedChromaAttr()

USD_API UsdAttribute CreateRedChromaAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

◆ CreateWhitePointAttr()

USD_API UsdAttribute CreateWhitePointAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

◆ Get() [1/2]

static USD_API UsdColorSpaceDefinitionAPI Get	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Return a UsdColorSpaceDefinitionAPI with name name holding the prim prim.

Shorthand for UsdColorSpaceDefinitionAPI(prim, name);

◆ Get() [2/2]

static USD_API UsdColorSpaceDefinitionAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdColorSpaceDefinitionAPI 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. path must be of the format <path>.colorSpaceDefinition:name .

This is shorthand for the following:

TfToken name = SdfPath::StripNamespace(path.GetToken());
UsdColorSpaceDefinitionAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

◆ GetAll()

static USD_API std::vector< UsdColorSpaceDefinitionAPI > GetAll ( const UsdPrim & prim )

static

Return a vector of all named instances of UsdColorSpaceDefinitionAPI on the given prim.

◆ GetBlueChromaAttr()

USD_API UsdAttribute GetBlueChromaAttr ( ) const

Blue chromaticity coordinates.


Declaration	`float2 blueChroma = (0, 0)`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

◆ GetGammaAttr()

USD_API UsdAttribute GetGammaAttr ( ) const

Gamma value of the log section.


Declaration	`float gamma = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

◆ GetGreenChromaAttr()

USD_API UsdAttribute GetGreenChromaAttr ( ) const

Green chromaticity coordinates.


Declaration	`float2 greenChroma = (0, 1)`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

◆ GetLinearBiasAttr()

USD_API UsdAttribute GetLinearBiasAttr ( ) const

Linear bias of the log section.


Declaration	`float linearBias = 0`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

◆ GetName()

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 113 of file colorSpaceDefinitionAPI.h.

◆ GetNameAttr()

USD_API UsdAttribute GetNameAttr ( ) const

The name of the color space defined on this prim.


Declaration	`uniform token name = "custom"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

◆ GetRedChromaAttr()

USD_API UsdAttribute GetRedChromaAttr ( ) const

Red chromaticity coordinates.


Declaration	`float2 redChroma = (1, 0)`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

◆ GetSchemaAttributeNames() [1/2]

static USD_API TfTokenVector GetSchemaAttributeNames	(	bool	includeInherited,
		const TfToken &	instanceName
	)

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name.

Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.

◆ GetSchemaAttributeNames() [2/2]

static USD_API const TfTokenVector & 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.

◆ GetWhitePointAttr()

USD_API UsdAttribute GetWhitePointAttr ( ) const

Whitepoint chromaticity coordinates.


Declaration	`float2 whitePoint = (0.33333334, 0.33333334)`
C++ Type	GfVec2f
Usd Type	SdfValueTypeNames->Float2

◆ IsColorSpaceDefinitionAPIPath()

static USD_API bool IsColorSpaceDefinitionAPIPath	(	const SdfPath &	path,
		TfToken *	name
	)

static

Checks if the given path path is of an API schema of type ColorSpaceDefinitionAPI.

If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

◆ IsSchemaPropertyBaseName()

static USD_API bool IsSchemaPropertyBaseName ( const TfToken & baseName )

static

Checks if the given name baseName is the base name of a property of ColorSpaceDefinitionAPI.

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 213 of file colorSpaceDefinitionAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 67 of file colorSpaceDefinitionAPI.h.

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

pxr/usd/usd/colorSpaceDefinitionAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsdColorSpaceDefinitionAPI() [1/2]

◆ UsdColorSpaceDefinitionAPI() [2/2]

◆ ~UsdColorSpaceDefinitionAPI()

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ CanApply()

◆ ComputeColorSpaceFromDefinitionAttributes()

◆ CreateBlueChromaAttr()

◆ CreateColorSpaceAttrsWithChroma()

◆ CreateColorSpaceAttrsWithMatrix()

◆ CreateGammaAttr()

◆ CreateGreenChromaAttr()

◆ CreateLinearBiasAttr()

◆ CreateNameAttr()

◆ CreateRedChromaAttr()

◆ CreateWhitePointAttr()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAll()

◆ GetBlueChromaAttr()

◆ GetGammaAttr()

◆ GetGreenChromaAttr()

◆ GetLinearBiasAttr()

◆ GetName()

◆ GetNameAttr()

◆ GetRedChromaAttr()

◆ GetSchemaAttributeNames() [1/2]

◆ GetSchemaAttributeNames() [2/2]

◆ GetWhitePointAttr()

◆ IsColorSpaceDefinitionAPIPath()

◆ IsSchemaPropertyBaseName()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind