rmanUtilities.h File Reference

Utilities for converting between USD encodings and Renderman encodings in cases where there is a difference. More...

Include dependency graph for rmanUtilities.h:

Go to the source code of this file.

Functions
USDRI_API int	UsdRiConvertToRManInterpolateBoundary (const TfToken &token)
	Given a token representing a UsdGeom interpolate boundary value, returns corresponding rman enum (converted to int).
USDRI_API const TfToken &	UsdRiConvertFromRManInterpolateBoundary (int i)
	Given the integer i that corresponds to an rman enum for interpolate boundary condition, returns the equivalent UsdGeom token.
USDRI_API int	UsdRiConvertToRManFaceVaryingLinearInterpolation (const TfToken &token)
	Given a token representing a UsdGeom face-varying interpolate boundary value, returns corresponding rman enum (converted to int).
USDRI_API const TfToken &	UsdRiConvertFromRManFaceVaryingLinearInterpolation (int i)
	Given the integer i that corresponds to an rman enum for face-varying interpolate boundary condition, returns the equivalent UsdGeom token.
USDRI_API int	UsdRiConvertToRManTriangleSubdivisionRule (const TfToken &token)
	Given a token representing a UsdGeom Catmull-Clark triangle subdivision rule value, returns corresponding rman enum (converted to int).
USDRI_API const TfToken &	UsdRiConvertFromRManTriangleSubdivisionRule (int i)
	Given the integer i that corresponds to an rman enum for a Catmull- Clark triangle subdivision rule, returns the equivalent UsdGeom token.
USDRI_API SdfStringListOp	UsdRiConvertRManSetSpecificationToListOp (std::string const &)
	Convert the given RenderMan set specification statement to an equivalent SdfStringListOp form.
USDRI_API bool	UsdRiDoesAttributeUseSetSpecification (TfToken const &attrName)
	Return true if an only if the given attribute name uses a string set specification representation in the RenderMan interface.

Detailed Description

Utilities for converting between USD encodings and Renderman encodings in cases where there is a difference.

Definition in file rmanUtilities.h.

Function Documentation

UsdRiConvertFromRManFaceVaryingLinearInterpolation()

USDRI_API const TfToken & UsdRiConvertFromRManFaceVaryingLinearInterpolation

(

int

i

)

Given the integer i that corresponds to an rman enum for face-varying interpolate boundary condition, returns the equivalent UsdGeom token.

UsdRiConvertFromRManInterpolateBoundary()

USDRI_API const TfToken & UsdRiConvertFromRManInterpolateBoundary

(

int

i

)

Given the integer i that corresponds to an rman enum for interpolate boundary condition, returns the equivalent UsdGeom token.

UsdRiConvertFromRManTriangleSubdivisionRule()

USDRI_API const TfToken & UsdRiConvertFromRManTriangleSubdivisionRule

(

int

i

)

Given the integer i that corresponds to an rman enum for a Catmull- Clark triangle subdivision rule, returns the equivalent UsdGeom token.

UsdRiConvertRManSetSpecificationToListOp()

USDRI_API SdfStringListOp UsdRiConvertRManSetSpecificationToListOp

(

std::string const &

)

Convert the given RenderMan set specification statement to an equivalent SdfStringListOp form.

RenderMan specifies certain set operations using a string encoding. The string form contains either a list of named groups, or a unary operator ("+" or "-") followed by a list of named groups. In set-algebra terms "+" is a union and "-" is a difference operator.

This method converts the string form to an equivalent USD type, SdfStringListOp.

The string representation is used implicitly for certain attributes; see UsdRiDoesAttributeUseSetSpecification().

Note

SdfStringListOp is more expressive than the RenderMan grouping membership representation, so lossless round-trip conversion is not possible in general.

See also

SdfStringListOp::ApplyOperations()

UsdRiConvertToRManFaceVaryingLinearInterpolation()

USDRI_API int UsdRiConvertToRManFaceVaryingLinearInterpolation

(

const TfToken &

token

)

Given a token representing a UsdGeom face-varying interpolate boundary value, returns corresponding rman enum (converted to int).

UsdRiConvertToRManInterpolateBoundary()

USDRI_API int UsdRiConvertToRManInterpolateBoundary

(

const TfToken &

token

)

Given a token representing a UsdGeom interpolate boundary value, returns corresponding rman enum (converted to int).

UsdRiConvertToRManTriangleSubdivisionRule()

USDRI_API int UsdRiConvertToRManTriangleSubdivisionRule

(

const TfToken &

token

)

Given a token representing a UsdGeom Catmull-Clark triangle subdivision rule value, returns corresponding rman enum (converted to int).

UsdRiDoesAttributeUseSetSpecification()

USDRI_API bool UsdRiDoesAttributeUseSetSpecification

(

TfToken const &

attrName

)

Return true if an only if the given attribute name uses a string set specification representation in the RenderMan interface.

Consult the RenderMan documentation for more details, but at time of writing, this includes the following:

• grouping:membership
• lighting:excludesubset
• lighting:subset
• lightfilter:subset