Accessing Document Features

You can get the document by importing the theApplication object from the Application module and calling theApplication.getCurrentDocument(). You can be notified when the current document has changed by listening for the DOCUMENT_LOADED message.

Using the document object, you can access many of the features of Showcase. Some commonly used features include:

• Shots
• Behaviors
• Alternatives
• Environments
• Storyboards
• Models
• Materials

In order to use features associated with the document you can call the corresponding methods to access the data. Some access methods and the data types that will be returned are as follows:

In order to use features associated with the document you must import the appropriate IO modules.

• getAlternatives() - Returns a list where the elements are of type AlternativeSet.AlternativeSet
• getModels() - Returns NodeContainers.SubGraph
• getModelImports() - Returns ModelImportIO.ModelImports
• getMaterials() - Returns MaterialIO.Materials
• getShots() - Returns ShotIO.ShotData
• getStoryboard() - Returns Storyboard.Storyboard
• getBehaviors() - Returns Behaviors.Behaviors
• getEnvironments() - Returns EnvironmentIO.EnvironmentList

You can also access the feature data by importing the feature module and using the method: document.get(IOfile.id).

For an example, refer to the ObjectInformation.py script in the extras\Interactive folder of the installation.