AL::usdmaya::fileio::translators::TranslatorTestType Class Reference

Inheritance diagram for AL::usdmaya::fileio::translators::TranslatorTestType:

Public Member Functions
	TranslatorTestType (const UsdPrim &prim=UsdPrim())
	TranslatorTestType (const UsdSchemaBase &schemaObj)
virtual	~TranslatorTestType ()
	Destructor.

Static Public Member Functions
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static TranslatorTestType	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a TranslatorTestType 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: More...
static TranslatorTestType	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 Attributes
static const bool	IsConcrete = true

Friends
class	UsdSchemaRegistry

Constructor & Destructor Documentation

AL::usdmaya::fileio::translators::TranslatorTestType::TranslatorTestType ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a TranslatorTestType on UsdPrim prim . Equivalent to TranslatorTestType::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

AL::usdmaya::fileio::translators::TranslatorTestType::TranslatorTestType ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a TranslatorTestType on the prim held by schemaObj . Should be preferred over TranslatorTestType(schemaObj.GetPrim()), as it preserves SchemaBase state.

Member Function Documentation

static TranslatorTestType AL::usdmaya::fileio::translators::TranslatorTestType::Define ( const UsdStagePtr &  stage, const SdfPath &  path  )

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 TranslatorTestType AL::usdmaya::fileio::translators::TranslatorTestType::Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a TranslatorTestType 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:

TranslatorTestType(stage->GetPrimAtPath(path));

static const TfTokenVector& AL::usdmaya::fileio::translators::TranslatorTestType::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.

Member Data Documentation

const bool AL::usdmaya::fileio::translators::TranslatorTestType::IsConcrete = true

static

Compile-time constant indicating whether or not this class corresponds to a concrete instantiable prim type in scene description. If this is true, GetStaticPrimDefinition() will return a valid prim definition with a non-empty typeName.

---

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

• src/lib/AL_USDMaya/AL/usdmaya/fileio/translators/TranslatorTestType.h