Marionette Node Reference
UNDER CONSTRUCTION
- Special thanks to user Tui Walker Kamakorewa for his work on this reference.
Attributes
Common
Attributes - Assigns this node's attributes to the input object
Get Operations
Get Arrow Style - Returns the arrow style parameters for the indicated object
Get Object Marker - Gets all properties for the specified marker of an object
Get Class - Returns the class assigned to the referenced object. A string "None" is returned if the object has no class assigned to it
Get Opacity - Returns the opacity of an object. Opacity is obtained as percentage value in range [0, 100]
Get Description - Retrieves any description text that exists for a specified object
Get Entity Matrix - Returns the matrix of the plane for a planar object
Get View Matrix - Returns the view matrix for a layer or viewport object
Get Opacity By Class - Determines whether the object is using a class opacity
Get Fill - Returns the fill properties of the referenced object
Get Line Attribute - Returns the line attributes of the referenced object
Get Fill Points - Returns start and axis end points of the fill. Note: only works with 2D objects that have a gradient or image fill
Get Marker - Returns marker information of the referenced object
Set Operations
Set Arrow Style Sets the arrow style parameters for the indicated object
Set Class Assigns a class to the referenced object
Set Description Sets the user-supplied description for an object. Adds the description data node if one does not already exist
Set Entity Matrix Sets the matrix of the plane for a planar object. If there is already a plane in the document with that matrix, the object will be set to be in that plane. Otherwise a new plane will be added to the document
Set Fill Sets the fill attributes of the specified object
Set Fill Color By Class Sets the referenced object to use the class attribute fill colors
Set Fill Pattern By Class Sets the referenced object to use the class attribute fill pattern
Set Line Attribute Sets the line attributes of the referenced object
Set Line Style By Class Sets the referenced object to use the class attribute line style
Set Line Weight By Class Sets the referenced object to use the class attribute line weight
Set Marker Specifies marker information for the referenced object - OBSOLETE procedure: Use SetObjBeginningMarker and/or SetObjEndMarker instead.
Set Marker By Class Sets the referenced object to use the class attribute marker style. Sets it so that the class arrow style is used for the referenced object
Set Object Marker Sets all properties of an object's marker
Set Opacity Sets the opacity of the object to the opacity passed in
Set Opacity By Class Sets the specified class to use the class opacity. If you set opacity to an object inside parametric the actual opacity will be combined with the opacity of the parametric object itself
Set Pen Color By Class Sets the referenced object to use the class attribute pen colors
Set View Matrix Sets view matrix for layer or viewport object
Set Text Style By Class Sets the referenced object to use the class text style. To undo this, use SetTextStyleRef on the object
Thumbnail Preview For a given VectorWorks resource (i.e. Hatch, Texture, Symbol/PIO, etc...), this function will create or update it's thumbnail preview
Conditionals
Is Fill Color By Class Returns whether class fill colors are used for the referenced object
Is Fill Pattern By Class Returns whether a class fill pattern is used for the referenced object
Is Line Style By Class Returns whether a class line style is used for the referenced object
Is Line Weight By Class Returns whether a class line weight is used for the referenced object
Is Marker By Class Returns whether a class marker style is used for the referenced object
Is Object Flipped Returns the flip orientation of the specified 3D object. This function works for sweeps, extrudes, multiple extrudes, symbols, solids, layer references, and plug-in objects
Is Pen Color By Class Returns whether class pen colors are used for the referenced object
Is Text Style By Class Determines whether the class text style is used for the referenced object
Classes
Data Flow
Debug
Dummy End
This is a dummy node that doesn't do anything. It is used to connect the ends of sub-networks to initate their execution.
Test List This node will test if the input list length matches the expected length. Optionaly it will also test the list contents. If the test fails the node will turn red and an alert dialog will be shown.
Test List At This node will test the value at a specified index within a list. If the values don't match, the node with turn red and an alert dialog will be shown.
Test Value This node will test if the input value matches the expected value. If the values dont match, the node with turn red and an alert dialog will be shown.
Input
Layers
Common
Get Active Layer Returns the current active layer in the document
Layer Creates a new layer in a VectorWorks document. After creation, the new layer becomes the active layer of the document. If the layer name passed to the procedure already exists, the procedure switches the active layer to the specified layer
Get Layer Returns the layer of the referenced object
Layer With Type Creates a layer of the specified type
Set Layer Adds an object to a specified layer
Others
Get First Layer Returns the first layer object in a VectorWorks document
Get Last Layer Returns the last layer object in a VectorWorks document
Get Layer By Name Returns a layer object given its name
Get Layer Count Returns the current number of layers within the active document
Get Layer Elevation Gets the elevation and thickness of the specified layer
Get Layer Name Returns the name of the referenced layer
Get Layer Visibility Returns the visibility of the referenced layer
Get Z Values Returns the Z (layer base elevation) and delta Z (layer thickness) values for the active layer
Get Object Count Returns the number of objects on the referenced layer
Hide Active Layer Sets the visibility status of the active layer to hidden. Objects on hidden layers will not be viewable from other layers
Set Z Values Sets the Z (layer base elevation) and delta Z (layer thickness) for the active layer
Show Active Layer Sets the visibility status of the active layer to visible. Newly created layers always defaulted to the Show mode
Math
Basic Math
Linear Algebra
Number-Theoretic and Representation
Power and Logarithmic
Trigonometric
Angular Conversion
Hyperbolic
Special
Constants
Complex Numbers - Conversion Coordinates
Complex Numbers - Power and Logarithmic
Complex Numbers - Trigonometry
Complex Numbers - Classification
Complex Numbers - Constants
Complex Numbers - Hyperbolic
Object Info
Objects
Arc
Circle
Line
Locus
NURBS
Oval
Poly2D
Poly3D
Rectangle
Solid
Text
Operations
Contents Returns the objects contained in a container like object. Supported container types include: Group, Layer, Mesh, Extrude, MultiExtrude, Sweep, Symbol Definition, Folder, Parametric Object, Data Node, Roof
Convert to Mesh Converts a group of 3D polygons into a mesh network.
Copy Makes a single copy of an object
Delete Deletes an object. Note: Objects to be deleted are saved in a list and are deleted at the end of the network execution. So, there is no risk of referencing an object that no longer exists
Duplicate Object Creates num duplicates of an object
Group This node adds objects to an existing group. If no group is supplied, a new one is created.
Move This node will move an object or point by an offset in 2D or 3D. If the object is planar this node does not move it outside of it's plane.
Orient This node sets the Z axis of a 3D object.
Planar Boolean This node performs a boolean operation between lists of objects. The operation will be performed for each possible combination of objects in the lists supplied.
Rotate This node will rotate a 2D or 3D object around "center" if provided. If not provided the object will be rotated about it's center
Scale This node will scale an object or vector
Transform2 This node will transform a 2D object or 2D vector
Set Plane This node will set the reference plane for 2D objects
Ungroup Decomposes the reference group into component objects.
Points
Distance Calculates the distance between 2 points
Get XY Return the x,y components of a point or vector
Get XYZ Return the x,y,z components of a point or vector
Get XYZOff Return the x,y,z components of a point and it's ofset from the origin
Highest Return only the highest of points in a list at the same x,y location
Lowest Return only the lowest of points in a list at the same x,y location
Point 2D Create a 2D point from x,y values
Point 3D Create a 3D point from x,y,z values
Project Projects 2D points onto a planar object in 3D space
Records & IFC
String
ASCII Letters Returns a string that is the concatenation of the ascii_lowercase and ascii_uppercase constants. This value is not locale-dependent
ASCII Lowercase Returns the string with the lowercase letters 'abcdefghijklmnopqrstuvwxyz'. This value is not locale-dependent and will not change
ASCII Uppercase Returns the string with the uppercase letters 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'. This value is not locale-dependent and will not change
Digits Returns the string '0123456789'
Format Resulting string is a result from the format string and the arguments. This node uses python formatting: https://docs.python.org/3.3/library/string.html#format-string-syntax
Hex Digits Returns the string '0123456789abcdefABCDEF'
Oct Digits Returns the string '01234567'
Punctuation Returns a string of ASCII characters which are considered punctuation characters in the current locale
Str Create a string from any input. If a list is converted to a string, then you can provide delimiter string
White Space Returns a string containing all ASCII characters that are considered whitespace. This includes the characters space, tab, linefeed, return, formfeed, and vertical tab