Vectorscript Available for Marionette

From Vectorworks Developer
Revision as of 13:08, 12 November 2015 by MFarrell (talk | contribs)
Jump to navigation Jump to search

Currently, the VS Function Appendix includes outdated Vectorscript functions.
I would like to have this direct to the functions that still work in 2016, which is when Marionette was introduced.
As time continues, I hope to have this page up-to-date with the functions users may incorporate within their personalized nodes.
I will update this page frequently as I come across discrepancies. MFarrell (talk) 16:12, 11 November 2015 (EST)

Classes

ActiveClass GetClLW LSByClass SetClLW
ClassList GetClOpacity LWByClass SetClOpacity
ClassNum GetClPenBack MarkerByClass SetClPenBack
DelClass GetClPenFore NameClass SetClPenFore
FPatByClass GetClUseGraphic OpacityByClass SetClUseGraphic
FillColorByClass GetClVectorFill PenColorByClass SetClUseTexture
GetCVis GetClassBeginningMarker RenameClass SetClVectorFill
GetClFPat GetClassEndMarker SetClFPat SetClassBeginningMarker
GetClFillBack GetClassOptions SetClFillBack SetClassEndMarker
GetClFillFore GrayClass SetClFillFore SetClassOptions
GetClLSN HideClass SetClLSN ShowClass

Color

RunColorPaletteMgr RunNewColorPalette RunPickClrFromPal

Command

Absolute DoMenuTextByName OpenPDFDocument PushAttrs
AcquireExportPDFSettingsAndLocation ExportPDFPages PenLoc Relative
AngleVar Move PopAttrs Run
CallTool MoveTo PrintUsingPrintDialog SetTool
ClosePDFDocument NoAngleVar PrintWithoutUsingPrintDialog

Criteria

Angle Height RoofArea_Total WallThickness
AreaN Hide RoofArea_TotalProj Width
BotBoundN IsFlipped SelectObj XCenterN
ComponentArea LeftBoundN Show XCoordinate
ComponentVolume LengthN SlabThickness YCenterN
Count ObjectType SurfaceAreaN YCoordinate
DSelectObj Perim TopBoundN ZCenterN
EditProperties PerimN VolumeN ZCoordinate
Eval RightBoundN WallArea_Gross
EvalStr RoofArea_Heated WallArea_Net
ForEachObject RoofArea_HeatedProj WallAverageHeight

Database / Record

DelRecord GetRField NumFields SetRecord
GetFldName GetRecord NumRecords
GetFldType LinkText Record
GetParametricRecord NewField SetRField

Dialogs - Modern

AddButtonMode CreateSwapPane GetNumImagePopupItems SetEdgeBinding
AddChoice CreateSymbolDisplayControl GetPatternData SetEditInteger
AddListBoxTabStop CreateTabControl GetPopUpChoiceIndex SetEditReal
AddListBrowserImage CreateTabPane GetSelectedChoiceIndex SetFirstGroupItem
AddRadioMode CreateThreeStateCheckBox GetSelectedChoiceInfo SetFirstLayoutItem
AdjustComponentPixelPos CreateThumbnailPopup GetSelectionRange SetFocusOnItem
AlignItemEdge CreateTreeControl GetStoryBoundChoiceStrings SetGradientSliderData
ClearGradientSliderSegments DeleteAllItems GetStoryBoundDataFromChoiceString SetGradientSliderSelectedMarker
CreateCenteredStaticText DeregisterDialogFromTimerEvents GetThreeStateCheckBoxState SetHelpText
CreateCheckBox DeselectEditText GetTreeControlItemData SetIconPushButtonState
CreateCheckBoxGroupBox DisplaySwapPane GetTreeControlItemText SetImageControlHandle
CreateClassPullDownMenu DisplayTabPane GetTreeControlSelectedItem SetImageControlPath
CreateColorPopup EnableItem GetTreeControlTextSelectedItem SetImagePopupSelectedItem
CreateCustThumbPopup EnableLBDropOnIndices InsertEnhanPullDownMenuItem SetItemClickable
CreateCustomControl EnableTextEdit InsertGradientSliderSegment SetItemText
CreateDesignLayerPullDownMenu ExpandTreeControlItem InsertImagePopupObjectItem SetItemToolTipText
CreateEditInteger GetActiveEditItem InsertImagePopupResource SetLBImageIndexes
CreateEditReal GetActivePane InsertImagePopupSeparator SetLayoutDialogPosition
CreateEditText GetBooleanItem InsertPropClassOrLayerItem SetLayoutDialogSize
CreateEditTextBox GetChoiceCount InsertTreeControlItem SetLayoutOption
CreateEnhancedPullDownMenu GetChoiceIndex IsClassChoiceSelected SetLineAttributeData
CreateGradient GetChoiceStringFromStoryBoundData IsItemEnabled SetLineStyleChoice
CreateGroupBox GetChoiceText IsItemVisible SetLineWeightChoice
CreateImageControl GetColorButton NotifyPullDownClicked SetListBoxTabStops
CreateImageControl2 GetColorChoice RefreshItem SetMarkerValue
CreateImagePushButton GetComponentRect RegisterDialogForTimerEvents SetPatternData
CreateLayout GetComponentTextWidth RemoveAllImagePopupItems SetProportionalBinding
CreateLineAttributePopup GetControlData RemoveChoice SetRightItem
CreateLineStylePopup GetEditInteger RemoveEnhancedPullDownMenuItemRange SetSelectionRange
CreateLineWeightPopup GetEditReal RemoveGradientSliderSegment SetSliderLiveUpdate
CreateListBox GetGradientSliderData RemoveImagePopupItem SetStaticTextColor
CreateListBoxN GetGradientSliderSelectedMarker RemoveListBoxTabStop SetStaticTextStyle
CreateMarkerPopup GetIconPushButtonState RemoveTreeControlItem SetThreeStateCheckBoxState
CreatePatternPopup GetImagePopupObject RunLayoutDialog SetTreeControlItemData
CreatePullDownMenu GetImagePopupObjectItemIndex RunNamedDialog SetVSResourceFile
CreatePullDownMenuGroupBox GetImagePopupSelectedItem SelectChoice ShowByClassChoice
CreatePushButton GetItemText SelectClassChoice ShowEditTileDialog
CreateRadioButton GetLBHeaderTextWidth SelectEditText ShowEditTileSettingsDialog
CreateRadioButtonGroupBox GetLayoutDialogPosition SelectTreeControlItem ShowEnhancedPullDownMenuGroupIcon
CreateResizableLayout GetLayoutDialogSize SetBelowItem ShowItem
CreateRightStaticText GetLineAttributeData SetBooleanItem ShowNewTileDialog
CreateSeparator GetLineStyleChoice SetColorButton UpdateImageControl2
CreateSheetLayerPullDownMenu GetLineWeightChoice SetColorChoice UpdateImagePushButton
CreateStandardIconControl GetMarkerPopupSelectedItem SetComponentIndeterminate UpdateSymbolDisplayControl
CreateStaticText GetMarkerValue SetComponentSize VerifyLayout
CreateStyledStatic GetMultilineText SetControlData
CreateSwapControl GetNumGradientSliderSegments SetControlText

Dialogs - Modern - Browser

AddLBOriginalName GetLBColumnHeaderToolTip GetNumLBColumnDataItems SetLBControlType
AreLBColumnLinesEnabled GetLBColumnOwnerDrawnType GetNumLBColumns SetLBDragDropColumn
AreLBRadioColumnLinesEnabled GetLBColumnSortState GetNumLBItems SetLBEditDisplayType
CollapseAllLBItems GetLBColumnWidth GetNumSelectedLBItems SetLBHierDispColumn
CreateLB GetLBControlType HierLBItemClosed SetLBItemDashStyle
DeleteAllLBItems GetLBEditDisplayType HierLBItemIsClosed SetLBItemData
DeleteLBColumn GetLBEventInfo HierLBItemIsContain SetLBItemDisplayType
DeleteLBItem GetLBItemDashStyle HierLBItemOpened SetLBItemFillBackColor
EnableLB GetLBItemData InsertLBColumn SetLBItemFillForeColor
EnableLBClickAllDataChange GetLBItemDisplayType InsertLBColumnDataItem SetLBItemGradientOrImageRefNumber
EnableLBColumnLines GetLBItemFillBackColor InsertLBItem SetLBItemInfo
EnableLBColumnTracking GetLBItemFillForeColor IsLBColumnTrackingEnabled SetLBItemPatternIndex
EnableLBDragAndDrop GetLBItemGradientOrImageRefNumber IsLBDisplayHier SetLBItemPenBackColor
EnableLBHierDisplay GetLBItemInfo IsLBItemSelected SetLBItemPenForeColor
EnableLBRadioColumnLines GetLBItemOrigName IsLBSortingEnabled SetLBItemTextColor
EnableLBSingleLineSelection GetLBItemPatternIndex RefreshLB SetLBItemTextJust
EnableLBSorting GetLBItemPenBackColor RemoveAllLBColumnDataItems SetLBItemTextStyle
EnableLBUpdates GetLBItemPenForeColor RemoveLBColumnDataItem SetLBItemUsingColumnDataItem
EnsureLBItemIsVisible GetLBItemTextColor SetFocusOnLB SetLBNumericItemInfo
ExpandAllLBItems GetLBItemTextJust SetLBColumnHeaderJust SetLBOrigNameClLevel
FindLBColumnDataItem GetLBItemTextStyle SetLBColumnHeaderToolTip SetLBSelection
FindLBColumnItem GetLBMultImageIndexes SetLBColumnImage SetLBSortColumn
GetLBColumnDataItemInfo GetLBOrigNameClLevel SetLBColumnOwnerDrawnType
GetLBColumnHeaderJust GetLBSortColumn SetLBColumnWidth

Dialogs - Predefined

AlertCritical AlertSetAlwaysDoVal DidCancel PtDialog
AlertInform AlrtDialog DistDialog PtDialog3D
AlertInformDontShowAgain AngDialog FormatTextDialog RealDialog
AlertQuestion AngDialog3D IntDialog StrDialog
AlertQuestionDontShowAgain DetailGraphicOptDlg NonUndoableActionOK YNDialog

Dimensions

AngularDim DimArcText GetDimText SetDimText
AssociateLinearDimension DimText HasDim SingleTolerance
CircularDim DoubleFixedTolerance LimitTolerance
CreateChainDimension DoubleTolerance LinearDim

Document Attributes

AddTileGeometryObject FPenColorByClass GetTileBackgroundColor SetDefaultBeginningMarker
CreateImageFromPaint FPenFore GetTileGeometryGroup SetDefaultEndMarker
CreateTile FPenPatN GetTileGroupParent SetDefaultOpacity
DS_GetAngle FPenSize GetTileOffsetPoint SetDefaultOpacityByClass
DS_GetFillStyle FillBack GetTileRepetitionPoint SetDocumentDefaultSketchStyle
DS_GetOffset FillFore InsertGradientSegment SetGradientData
DS_GetOffsetUnit FillPat IsTileGroupContainedObject SetGradientMidpointPosition
DS_GetOpacity GetDashStyle IsUserColor SetGradientSpotColor
DS_IsOpacityByClass GetDashStyleIndex NumColors SetGradientSpotPosition
FFPatByClass GetDefaultBeginningMarker NumDashStyles SetTileBackgroundColor
FFillBack GetDefaultEndMarker Opacity SetTileOffsetPoint
FFillColorByClass GetDefaultOpacity PenBack SetTileRepetitionPoint
FFillFore GetDocumentDefaultSketchStyle PenFore SheetList
FFillPat GetGradientData PenPatN SheetNum
FLSByClass GetGradientMidpointPosition PenSize ShowCreateImageDialog
FLWByClass GetGradientSpotColor RemoveGradientSegment ShowGradientEditorDialog
FMarkerByClass GetGradientSpotPosition SetDashStyle ShowPlanShadowsTab
FPenBack GetNumGradientSegments SetDashStyleN

Document List Handling

AddResourceToList FInLayer ImportResourceToCurrentFile PrevDObj
BuildResourceList FInSymDef LActLayer PrevLayer
BuildResourceList2 FObject LNewObj PrevObj
BuildResourceListN FSActLayer LObject PrevSObj
BuildResourceListN2 FSObject LSActLayer PrevSymDef
DeleteResourceFromList FSymDef NextDObj ResourceListSize
FActLayer GetActualNameFromResourceList NextLayer SetParent
FIn3D GetNameFromResourceList NextObj
FInFolder GetResourceFromList NextSObj
FInGroup ImportResToCurFileN NextSymDef

Document Settings

DeleteAllDLComponents GetDLOptions GridLines SetDLOptions
DeleteDLComponent GetDLSeparation InsertNewDLComponent SetDLSeparation
DrwSize GetDefaultTextSize PenGrid SetDimStd
GetCurrentPlanarRefID GetDrawingSizeRect SetConstrain SetOrigin
GetDLComponentClass GetDrawingSizeRectN SetDLComponentClass SetOriginAbsolute
GetDLComponentFill GetFName SetDLComponentFill SetPref
GetDLComponentFillColors GetNumberOfDLComponents SetDLComponentFillColors SetPrefInt
GetDLComponentName GetOrigin SetDLComponentName SetPrefLongInt
GetDLComponentPenColors GetPref SetDLComponentPenColors SetPrefRGB
GetDLComponentPenStyles GetPrefInt SetDLComponentPenStyles SetPrefReal
GetDLComponentPenWeights GetPrefLongInt SetDLComponentPenWeights SetPrefString
GetDLComponentUseFillClassAttr GetPrefRGB SetDLComponentUseFillClassAttr SetPrimaryDim
GetDLComponentUsePenClassAttr GetPrefReal SetDLComponentUsePenClassAttr SetSecondaryDim
GetDLComponentWidth GetPrefString SetDLComponentWidth SetUnits
GetDLControlOffset GetWallPrefStyle SetDLControlOffset SetWallPrefStyle

File I/O

Append FindFileInPluginFolder ImportIGES StdRead
Close GetFPathName ImportSAT StdReadLn
ConvertHSF2PosixPath GetFile Open Tab
ConvertPosix2HSFPath GetFileInfo PutFile UseDefaultFileErrorHandling
CreateFolder GetFileN Read Write
EOF GetFilesInFolder ReadLn WriteLn
EOLN GetFolder Rewrite WriteLnMac
ExportIGES GetFolderPath SaveActiveDocument WriteMac
ExportSAT GetLastFileErr Space

GIS

EditGeorefWithUI GetGISOrigin GetProjectionWKT LegacyShapefileImp
GeogCoordToVW GetProjectionLocName IsGeoreferenced SetGISLayer
GetAngleToNorth GetProjectionProj4 LegacyShapefileExp VWCoordToGeog

General Edit

AlignDistribute2D FlipVer MoveBack RotatePoint
AlignDistribute3D Forward MoveFront Scale
Backward GetScriptResource ResetOrientation3D SetScriptResource
CreateScriptResource LckObjs Rotate UnLckObjs
FlipHor MirrorXY3D Rotate3D

Graphic Calculation

CalcPolySegLen Eq GetZatXY PtOnArc
Centroid EqPercent HCenter PtOnLine
CircleCircleInters EqPt LineCircleIntersect PtPerpCircle
ClipPolygon EqPt2D LineEllipseIntersect PtPerpLine
ClosestPoints EqPt3D LineLineIntersection RegularPolygon
Cloud EqualPt OffsetPoly RelativeCoords
CombinePolygons EqualRect OffsetPolyN Split2DObjectByLine
ConvertToArcPolyline FindObjAtPt_Create OverlapLineArc SrndArea
ConvertToPolygon FindObjAtPt_Delete OverlapLineLine Stipple
ConvertToPolyline FindObjAtPt_GetCount PointAlongPoly SubtractPolygon
CutProfileHoles FindObjAtPt_GetObj PointAlongPolyN ThreePtCenter
Distance GetObjectHiddenLine PolyMedialAxis UnionRect
Distance3D GetPtInPoly PtInPoly
EllipseEllipseIntersect GetWallHeight PtInRect

Hatches / Vector Fills

AddVectorFillLayer CreateStaticHatchFromObject GetVectorFill SetVectorFill
BeginVectorFillN DelVectorFill GetVectorFillDefault SetVectorFillDefault
CreateStaticHatch EndVectorFill NumVectorFills VectorFillList

IFC

IFC_AttachPset IFC_GetEntityProp IFC_ImportLibrary IFC_SetIFCEntity
IFC_ClearIFCInfo IFC_GetIFCEntity IFC_ImportNoUI IFC_SetPsetProp
IFC_CopyIFCData IFC_GetNumPsets IFC_ImportWithUI
IFC_ExportWithUI IFC_GetPsetName IFC_SetEntityColor
IFC_GetEntityColor IFC_GetPsetProp IFC_SetEntityProp

ImportExport

DXFScaleString GetLastDXFImportOpt ImportSingleDXFDWG SetDXFColorToLW
ExportDXFDWG ImportDXFDWG Init3DSServices SetLastDXFImportOpt
GetDXFColorToLW ImportDXFDWGFile InitDWGServices

Layers

ActLayer GetLayerForStory GetZVals SetLScale
AssociateLayerWithStory GetLayerLevelType GrayLayer SetLayerElevation
CopyMode GetLayerOptions HGetLayerTransp SetLayerLevelType
CreateLayer GetLayerRenderMode HSetLayerTransp SetLayerOptions
CreateLayerLevelType GetLayerTransparency HideLayer SetLayerRenderMode
CreateStory GetLevelTypeName IsLayerReferenced SetLayerTransparency
CreateStoryLayerTemplate GetNumLayerLevelTypes LFillBack SetLevelTypeName
DeleteStoryLayerTemplate GetNumStories LFillFore SetScale
DisplayLayerScaleDialog GetNumStoryLayerTemplates LLayer SetSheetLayerUserOrigin
FLayer GetSheetLayerUserOrigin LPenBack SetStoryElevation
GetLName GetStoryAbove LPenFore SetStorySuffix
GetLScale GetStoryBelow Layer SetZVals
GetLVis GetStoryElevation LayerRef ShowLayer
GetLayer GetStoryLayerTemplateName NumLayers
GetLayerByName GetStoryOfLayer NumObj
GetLayerElevation GetStorySuffix SetDefStoryLayerName

Math - General

Abs Deg2Rad Rad2Deg Sqrt
ArcCos Exp Random Tan
ArcSin Ln Round Trunc
ArcTan Max Sin
Cos Min Sqr

Math - Vectors

Ang2Vec CrossProduct Perp
AngBVec DotProduct UnitVec
Comp Norm Vec2Ang