AL_USDMaya  0.29.4
USD to Maya Bridge
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
AL::usdmaya::nodes::proxy::PrimFilterInterface Struct Referenceabstract

The prim filter needs to know about some state provided in the proxy shape node. In order to maintain a separation between the filter and the proxy (so that it's easy to test!), this class acts as a bridge between the two. More...

#include <PrimFilter.h>

Inheritance diagram for AL::usdmaya::nodes::proxy::PrimFilterInterface:
AL::usdmaya::nodes::ProxyShape

Public Member Functions

virtual TfToken getTypeForPath (const SdfPath &path)=0
 Given a path to a prim, this method will return some type information for the prim found at that path, which the proxy shape has previously cached (i.e. the old state of the prim prior to a variant switch). If the proxy shape is aware of the prim, and the returned info is valid, true will be returned. If the proxy shape is unaware of the prim (i.e. a variant switch has created it), then false will be returned. More...
 
virtual bool getTypeInfo (TfToken type, bool &supportsUpdate, bool &requiresParent)=0
 for a specific type, this method should return whether it supports update, and if that type requires a DAG path to be created. More...
 

Detailed Description

The prim filter needs to know about some state provided in the proxy shape node. In order to maintain a separation between the filter and the proxy (so that it's easy to test!), this class acts as a bridge between the two.

Member Function Documentation

virtual TfToken AL::usdmaya::nodes::proxy::PrimFilterInterface::getTypeForPath ( const SdfPath &  path)
pure virtual

Given a path to a prim, this method will return some type information for the prim found at that path, which the proxy shape has previously cached (i.e. the old state of the prim prior to a variant switch). If the proxy shape is aware of the prim, and the returned info is valid, true will be returned. If the proxy shape is unaware of the prim (i.e. a variant switch has created it), then false will be returned.

Parameters
paththe path to the prim we are querying
Returns
true if the prim is known about, and the info structure contains valid information. False if the prim is an unknown type
virtual bool AL::usdmaya::nodes::proxy::PrimFilterInterface::getTypeInfo ( TfToken  type,
bool &  supportsUpdate,
bool &  requiresParent 
)
pure virtual

for a specific type, this method should return whether it supports update, and if that type requires a DAG path to be created.

Parameters
typethe type to query
supportsUpdatereturned value that indicates if the type in question can be updated
requiresParentreturned value that indicates whether the type in question needs a DAG path to be created
Returns
returns false if the type is unknown, true otherwise
The documentation for this struct was generated from the following file: