Difference between revisions of "Shape"

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: MultiViewObject'' === Methods === {| class="wikitable" ! scope=...")
 
Line 1: Line 1:
The Session object stores all the [[Node|Nodes]] to create the output for a specific shot.
+
The Shape object represents a Bézier, B-Spline, or X-Spline shape that can animate over time.
  
''Base Class: [[MultiViewObject]]''
+
''Base Class: [[StereoscopicObject]]''
 +
 
 +
=== Attributes ===
 +
 
 +
''Attributes are read-only unless noted.''
 +
{| class="wikitable"
 +
! scope="col" | Name
 +
! scope="col" class="unsortable" | Description
 +
|-
 +
|blendMode
 +
|the [[Silhouette Module Reference#Blend Mode|blend mode]]
 +
|-
 +
|blurType
 +
|the [[Silhouette Module Reference#Blur Type|blur type]]
 +
|-
 +
|closed
 +
|True if the shape is closed
 +
|-
 +
|inverted
 +
|True if the shape alpha should be inverted
 +
|-
 +
|path
 +
|the ''path'' property (same as <tt>shape.property('path')</tt> or <tt>shape['path']</tt>)
 +
|-
 +
|range
 +
|the shape's ''t-range'' as a tuple (start, end)
 +
|-
 +
|shapeType
 +
|the [[#Shape Type|shape type]]
 +
|}
  
 
=== Methods ===
 
=== Methods ===
Line 9: Line 38:
 
! scope="col" class="unsortable" | Description
 
! scope="col" class="unsortable" | Description
 
|-
 
|-
|getPosition(frame)
+
|createPath()
|return the tracker [[Point3D|position]] at <tt>frame</tt>
+
|create and return a new empty [[ShapePath|path]] - set with <tt>setPath()</tt>
 +
|-
 +
|createPath(frame)
 +
|create and return a new empty [[ShapePath|path]] and set a key at <tt>frame</tt>
 +
|-
 +
|evalPath(frame)
 +
|interpolate and return a [[ShapePath|path]] at the desired frame
 +
|-
 +
|setPath(path, frame)
 +
|set the [[ShapePath|path]] as a keyframe at <tt>frame</tt>
 
|}
 
|}
  
 
=== Constants ===
 
=== Constants ===
  
==== Mode ====
+
==== Shape Type ====
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 21: Line 59:
 
! scope="col" class="unsortable" | Description
 
! scope="col" class="unsortable" | Description
 
|-
 
|-
|Mode_RGB
+
|Bezier
|track all three channels
+
|a Bézier shape
|-
 
|Mode_Luminance
 
|track luminance
 
|-
 
|Mode_R
 
|track red channel
 
 
|-
 
|-
|Mode_G
+
|Bspline
|track green channel
+
|a B-Spline shape
 
|-
 
|-
|Mode_B
+
|Xspline
|track blue channel
+
|an X-Spline shape
 
|}
 
|}

Revision as of 16:23, 21 November 2012

The Shape object represents a Bézier, B-Spline, or X-Spline shape that can animate over time.

Base Class: StereoscopicObject

Attributes

Attributes are read-only unless noted.

Name Description
blendMode the blend mode
blurType the blur type
closed True if the shape is closed
inverted True if the shape alpha should be inverted
path the path property (same as shape.property('path') or shape['path'])
range the shape's t-range as a tuple (start, end)
shapeType the shape type

Methods

Name Description
createPath() create and return a new empty path - set with setPath()
createPath(frame) create and return a new empty path and set a key at frame
evalPath(frame) interpolate and return a path at the desired frame
setPath(path, frame) set the path as a keyframe at frame

Constants

Shape Type

Name Description
Bezier a Bézier shape
Bspline a B-Spline shape
Xspline an X-Spline shape