Difference between revisions of "Session"

From Silhouette Wiki
Jump to navigation Jump to search
(Created page with "The Session object stores all the Nodes to create the output for a specific shot. ''Base Class: Object'' === Attributes === ''Attributes are read-only except w...")
 
Line 13: Line 13:
 
|the session [[Silhouette Module Reference#Depth Constants|depth]] (''read/write'')
 
|the session [[Silhouette Module Reference#Depth Constants|depth]] (''read/write'')
 
|-
 
|-
|color
+
|duration
|the object [[Color]] - not all objects have a way of changing their color (''read/write'')
+
|the duration in frames
 
|-
 
|-
|id
+
|frameRate
|the unique id as string
+
|the frame rate
 
|-
 
|-
|label
+
|nodes
|the object label (''read/write'')
+
|List of [[Node|Nodes]] in the session
 
|-
 
|-
|locked
+
|pixelAspect
|True if locked (''read/write'')
+
|the pixel aspect
 
|-
 
|-
|note
+
|project
|the object note (''read/write'')
+
|the [[Project]] containing the session
 
|-
 
|-
|parent
+
|renderInfo
|the parent Object, or None
+
|the [[RenderInfo|rendering settings]]
 
|-
 
|-
|properties
+
|size
|the dictionary of [[Property|Properties]]
+
|the size as a Tuple of (width, height)
 
|-
 
|-
|selected
+
|startFrame
|True if selected
+
|the start frame number
 
|-
 
|-
|type
+
|workRange
|the object type name
+
|the current work range as a Tuple of (start_frame, end_frame)
|-
 
|visible
 
|True if visible (''read/write'')
 
 
|}
 
|}
  

Revision as of 21:54, 20 November 2012

The Session object stores all the Nodes to create the output for a specific shot.

Base Class: Object

Attributes

Attributes are read-only except where noted.

Name Description
depth the session depth (read/write)
duration the duration in frames
frameRate the frame rate
nodes List of Nodes in the session
pixelAspect the pixel aspect
project the Project containing the session
renderInfo the rendering settings
size the size as a Tuple of (width, height)
startFrame the start frame number
workRange the current work range as a Tuple of (start_frame, end_frame)

Methods

Name Description
property(name) returns the Property with the property name, or None
clone() returns a deep clone of the object and children
getTransform(frame) returns the accumulated transform at the specified time. This is a convenience method only useful for Layers and their children.

Operators

Name Description
object[prop_id] the map operator can be used as shorthand for object.property(prop_id)