Difference between revisions of "Paint"

From Silhouette Wiki
Jump to navigation Jump to search
(Created page with "The Paint object is a global object used to interact with the Paint UI while in the Paint Node. === Attributes === {| class="wikitable" ! scope="col" | Name ! scope="col...")
 
Line 7: Line 7:
 
! scope="col" class="unsortable" | Description
 
! scope="col" class="unsortable" | Description
 
|-
 
|-
−
|angle
+
|align
−
|The current display angle, when rotate mode is enabled.
+
|True if the Clone overlay mode is set to Align.
 
|-
 
|-
−
|blend
+
|alphaSource
−
|The current blend amount, for blending between views in supported nodes.
+
|The current alpha source used for ''Obey Alpha''. (0=input, 1=output)
 
|-
 
|-
−
|channelMask
+
|brush
−
|The current channel mask, as a [[Color]].
+
|The current brush name.
 
|-
 
|-
−
|colorSpace
+
|brushes
−
|The current OCIO display colorspace name.
+
|The List of available brush names. (''read-only'')
 
|-
 
|-
−
|device
+
|brushSize
−
|The current OCIO display device name.
+
|The current brush size (diameter in pixels).
 
|-
 
|-
−
|exposure
+
|channelMask
−
|The current display exposure value.
+
|The target channel mask as a [[Color]].
−
|-
 
−
|gamma
 
−
|The current display gamma value.
 
−
|-
 
−
|hand
 
−
|True if viewer rotate angle edit mode is enabled.
 
−
|-
 
−
|lut
 
−
|The current OCIO display LUT name, or None.
 
−
|-
 
−
|magnify
 
−
|True if the magnifier is enabled.
 
−
|-
 
−
|maskEnabled
 
−
|True if the frame mask is enabled.
 
−
|-
 
−
|node
 
−
|The active edit [[Node]]. Setting this will change the [[Node]] being edited.
 
−
|-
 
−
|overlay
 
−
|True if the overlay is enabled.
 
−
|-
 
−
|rotate
 
−
|True if viewer rotate mode is enabled.
 
 
|-
 
|-
−
|stabilize
+
|cloneOffset
−
|True if stabilization is enabled.
+
|The current clone offset as a [[Point3D]].
 
|-
 
|-
−
|stereo
+
|invertAlpha
−
|True if the current [[Node]] generates or passes stereo data.
+
|True if ''Invert Alpha'' is on.
 
|-
 
|-
−
|stereoAlign
+
|matchMove
−
|True if in stereo alignment mode
+
|True if ''Match Move'' is on.
 
|-
 
|-
−
|streamMask
+
|opaqueAlpha
−
|The current [[Silhouette Module Reference#Stream Mask Constants|Stream Mask]] (''read-only''), indicating which streams the current [[Node]] generates or passes (ie. the available streams).
+
|True if ''Opaque Alpha'' is on.
 
|-
 
|-
−
|streamMode
+
|onionSkin
−
|The current [[Silhouette Module Reference#Stream Mode Constants|Stream Mode]]. Check the <tt>streamMask</tt> attribute to determine the available streams.
+
|True if the Clone overlay mode is on.
 
|-
 
|-
−
|toolName
+
|onionSkinMix
−
|The current tool name.
+
|The mix value of the Clone overlay.
 
|-
 
|-
−
|updateMode
+
|opacity
−
|The current update mode (0=Drag, 1=Adaptive, 2=Release, 3=Manual)
+
|The current brush opacity.
 
|-
 
|-
−
|viewMode
+
|preset
−
|The current view mode (the number of available view modes depends on the current edit [[Node]])
+
|The current Preset index.
 
|-
 
|-
−
|viewNode
+
|profileType
−
|The current viewing [[Node]]. Note the view node can be different than the edit node.
+
|The current Brush Profile index (0=Circle, 1=Square)
 
|-
 
|-
−
|xform
+
|transformMode
−
|The current OCIO display transform name.
+
|True if Clone Interactive Transform mode is enabled.
 
|-
 
|-
−
|zoom
+
|cloneOffsetModifier
−
|The current zoom level (1=1:1, -1=zoom-to-fit)
+
|The [[Silhouette Module Reference#Modifier Constants|Modifier]] used for setting the Clone Offset
 
|-
 
|-
−
|zoomFactor
+
|brushEditModifier
−
|The current 'zoom factor' preference value.
+
|The [[Silhouette Module Reference#Modifier Constants|Modifier]] used for editing the Brush Size.
 
|}
 
|}
  

Revision as of 14:47, 20 November 2012

The Paint object is a global object used to interact with the Paint UI while in the Paint Node.

Attributes

Name Description
align True if the Clone overlay mode is set to Align.
alphaSource The current alpha source used for Obey Alpha. (0=input, 1=output)
brush The current brush name.
brushes The List of available brush names. (read-only)
brushSize The current brush size (diameter in pixels).
channelMask The target channel mask as a Color.
cloneOffset The current clone offset as a Point3D.
invertAlpha True if Invert Alpha is on.
matchMove True if Match Move is on.
opaqueAlpha True if Opaque Alpha is on.
onionSkin True if the Clone overlay mode is on.
onionSkinMix The mix value of the Clone overlay.
opacity The current brush opacity.
preset The current Preset index.
profileType The current Brush Profile index (0=Circle, 1=Square)
transformMode True if Clone Interactive Transform mode is enabled.
cloneOffsetModifier The Modifier used for setting the Clone Offset
brushEditModifier The Modifier used for editing the Brush Size.

Methods

Name Description
autoAlign(y_axis=False) If there is an active Layer, perform an auto-alignment and the current cursor position.
centerSelection() Center the viewer on the current selection.
enableNode(node_type, state) Enable or disable the Node with the given type.
nodeAvailable(node_type) True if the Node of type is in the current Session.
nodeEnabled(node_type) True if the Node of type is enabled.
queryTool(state) Query the current tool state. See Tool Commands for more information.
selectTool(name) Switch to the tool with the name, if exposed by the current edit Node.
setChannelMask(color) Set the channel mask to the Color. Same as assigning to the channelMask attribute.
setControlBind(controlName, key) Bind the key to the control with the given name.
setMagnify(state) Enable the magnifier if True. Same as assigning to the magnify attribute.
setMask(mask) Set and display the view mask with the given name.
setOverlay(state) Enable the overlay if True. Same as assigning to the overlay attribute.
setStabilize(state) Enable viewer stabilization if True. Same as assigning to the stabilize attribute.
setToolBind(toolName, key) Bind the key to the tool with the given name.
setUpdateMode(mode) Set the update mode. Same as assigning to the updateMode attribute.
setViewMode(mode) Set the view mode. Same as assigning to the viewMode attribute.
setZoom(zoom) Set the zoom level. Same as assigning to the zoom attribute.
toolCommand(command, modifier=False) Send the command to the current tool. See Tool Commands for more information.
Retrieved from "http://documentation.borisfx.com/wiki/sfx/index.php?title=Paint&oldid=97"