Difference between revisions of "Object"

From Silhouette Wiki
Jump to navigation Jump to search
Line 60: Line 60:
 
|returns a deep clone of the object and children
 
|returns a deep clone of the object and children
 
|-
 
|-
|getTransform(frame)
+
|getTransform(frame, collapsed=True)
|returns the accumulated [[Matrix|transform]] at the specified time. This is a convenience method only useful for [[Layer|Layers]] and their children.
+
|returns the accumulated [[Matrix|transform]] at the specified time. This is a convenience method only useful for [[Layer|Layers]] and their children. If the object is a [[Layer]] and collapsed is set to False, this returns only the Layer's transform matrix.
 
|}
 
|}
  

Revision as of 13:02, 3 May 2017

The Object is the common base class for all of Silhouette's primary data objects. All objects have a unique id, user-editable label, and contain Properties.

# print the list of property names for the first selected object
object = fx.selection()[0]
print object.properties.keys()

Attributes

Attributes are read-only except where noted.

Name Description
children List of child objects or None
color the object Color - not all objects have a way of changing their color (read/write)
id the unique id as string
label the object label (read/write)
locked True if locked (read/write)
note the object note (read/write)
parent the parent Object, or None
properties the dictionary of Properties
selected True if selected
type the object type name
visible True if visible (read/write)

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, collapsed=True) returns the accumulated transform at the specified time. This is a convenience method only useful for Layers and their children. If the object is a Layer and collapsed is set to False, this returns only the Layer's transform matrix.

Operators

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