Scripting API

<<PictureFrame Main Index Pinch>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

PictureTube

Script Name: PictureTube
Name: PictureTube
Library: CmdBase2
Description: Paints with a series of image objects.
Status bar text: Picture Tube Tool: Use to paint with pictures
Tool tip text: Picture Tube Tool
Undo text: Picture Tube
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
BrushTipParameter RepositoryTempLinkNo
BrushParameter RepositoryTempLinkNo
Placement ModePlacementEnumeration (TubePlacementMode)Specifies if placement is random or continuousYesRandom
ScaleScaleIntegerSpecifies the size of the painted object as a percentage of the original sizeYes000
Selection ModeSelectionModeEnumeration (TubeSelectionMode)Specifies how images (cells) are sequencedYesRandom
StepStepIntegerSelects the distance between painted tube elements, in pixelsYes000
Tube NameTubeNameStringSelects the name of the picture tubeYes
Cells AcrossCellsAcrossIntegerSets the number of cells across contained within the picture tube fileYes000
Cells DownCellsDownIntegerSets the number of cells down contained within the picture tube fileYes000
Cells TotalCellsTotalIntegerSets the total number of cells contained within the picture tube fileYes000
Cell IndexCellIndexIntegerSpecifies the next cell of the picture tube to paint (incremental mode only)No00499
Tube CategoryCategoryStringSpecifies the category to search for the tubeNo
Create as new raster layerTubeNewRasterLayerEnumeration (Boolean)Create as new raster layerNoFalse
PrimaryMaterialEnumeration (MaterialRef)TempLinkNoForeground
ForegroundMaterialParameter RepositoryTempLinkYes
BackgroundMaterialParameter RepositoryTempLinkYes
StrokeStrokeListThe path of the brush stroke.No0
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
NoRepeat: true
Has Random Seed: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes: