primSpec.h File Reference

Include dependency graph for primSpec.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	SdfPrimSpec
	Represents a prim description in an SdfLayer object. More...

Functions
SDF_API SdfPrimSpecHandle	SdfCreatePrimInLayer (const SdfLayerHandle &layer, const SdfPath &primPath)
	Convenience function to create a prim at the given path, and any necessary parent prims, in the given layer. More...
SDF_API bool	SdfJustCreatePrimInLayer (const SdfLayerHandle &layer, const SdfPath &primPath)
	Convenience function to create a prim at the given path, and any necessary parent prims, in the given layer. More...

Function Documentation

SdfCreatePrimInLayer()

SDF_API SdfPrimSpecHandle SdfCreatePrimInLayer	(	const SdfLayerHandle &	layer,
		const SdfPath &	primPath
	)

Convenience function to create a prim at the given path, and any necessary parent prims, in the given layer.

If a prim already exists at the given path it will be returned unmodified.

The new specs are created with SdfSpecifierOver and an empty type. primPath must be a valid prim path.

SdfJustCreatePrimInLayer()

SDF_API bool SdfJustCreatePrimInLayer	(	const SdfLayerHandle &	layer,
		const SdfPath &	primPath
	)

Convenience function to create a prim at the given path, and any necessary parent prims, in the given layer.

If a prim already exists at the given path, do nothing and return true.

Any newly created specs have SdfSpecifierOver and an empty type. primPath must be a valid prim path. Return false and issue an error if we fail to author the required scene description.