Salutz Tools Guide, v0.6.7

Fill and Pen may be set on a per-object basis via the VW Attribute Palette. Hatches, Gradients, etc. may be used, but can not have local settings per object.

Font options can be changed by altering the text attributes of the object via the Text menu or the Format Text box. Change color by using the Text Color Paramenter and object Pen Color.

Gap from the inner rectangle to the outer rectangle.

Gap from the text to the inner rectangle.

Draws both rectangles as rounded rectangles.

Toggles visibility of the inner rectangle. If visible, the inner rectangle will always have a white fill and a line style set by the Inner Rectangle Line Style parameter.

Choices: Solid, Dashed, Dashed Spaced, Dotted, None.

Draws between 1 and 4 duplicate rectangles within the gap between Inner and Offset rectangles.

Choose whether text should be Black, White, or Follow Object Pen Color.

Choose whether the object's insertion point is at its Center or at the tip of the Arrow.

Options: No Arrow, Left, Right, Top, Bottom

Scaled as 1 = 100% scale, 2 = 200% scale, etc.

Fill and Pen may be set on a per-object basis via the VW Attribute Palette. Hatches, Gradients, etc. may be used, but can not have local settings per object.

Font options can be changed by altering the text attributes of the object via the Text menu or the Format Text box. Change color by using the Text Color Paramenter and object Pen Color. Notes text size is set by Notes Text Size Parameter.

The object has the standard 8 Vectorworks handles for re-shaping with the mouse.

Draws both rectangles as rounded rectangles.

Gap from the inner rectangle to the outer rectangle.

Gap from the contents to the inner rectangle.

Choose whether text should be Black, White, or Follow Object Pen Color.

Choices: Solid, Dashed, Dashed Spaced, Dotted, None, Cut-Out.

Draws between 1 and 4 duplicate rectangles within the gap between Inner and Offset rectangles.

Choices: None, Underline, Box.

Places Label Text at one of the following positions. Alignment is always set to centered.

• Inside
• Outside
• Pad: In the middle of the gap between Inner rectangle and contents.
• Offset: In the middle of the gap between Offset and Inner rectangles.

Choices: Left, Center, Right, Justify.

This brings up a dialog box to edit the notes text.

• Alignment is set to left-aligned in the dialog box, but will align on drawing based on Note Horiz. Align parameter.
• Newline/paragraph breaks are allowed.
• Tabs may be entered on a Mac with key sequence <Alt>-<Shift>-<Tab>.
• Currently limited to 2,047 characters.

This sets the width of tab characters in the Notes text. The object is set to default to 1/2" because that is the spacing the VW dialog box shows as a default.

Tab characters may be entered on a Mac with key sequence <Alt>-<Shift>-<Tab>.

Bullet Lists may be entered on a Mac with <Alt>-<Tab>.

NOTE: This functionality is not tested on Windows.

Sets the color of the Type flag. This can be useful for using class coloring for different types of positions/departments.

Sets the color of the Purpose. This can be useful for using class coloring for different types of positions/departments.

Lineweight can be set by the user.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box. All other font attributes (aside from color) are dictated by the object.

A text string for the lineset number. It is set as a string to allow for letter modifiers (eg. "Lineset 25a").

The Spotlight Numbering Command can be used to automatically number this field.

Sets whether label points left or right.

The Name or Label or contents of the Lineset.

Dropdown list of common departments that might put equipment on linesets. This information does not display on the drawing; it is mainly used for displaying in worksheet summaries.

If the field is set to LX, the Purpose field will be bolded.

If this field in non-zero, it will draw a box extension past the point of the label. This can serve as a visual guide if a particular hanging piece would block nearby battens or cause interference.

This field is only used if Use Object Y position for Plasterline Distance? is deselected.

If Object Z is 0", value does not display on drawing.

This field is only used if Use Object Z position for Trim? is deselected. If Trim is 0", value does not display on drawing.

Set the weight load of the lineset as a number. This value will only appear on the drawing if it is non-zero.

Units used for the weight load (ie. lbs, kg, bricks).

Any additional notes for the lineset. This information does not display on the drawing; it is mainly used for displaying in worksheet summaries.

Sets the color of the decorative arrow shape and the color/linetype of the Leader Line.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box. All other font attributes are dictated by the object.

Choices: Regular, Bubble, Small, or Micro

Sets the size and style of the label.

Note: In Small and Micro styles, if Position Name is more than 2 characters it will overshoot the edges of the object, therefore the text will be scaled down to fit inside the circle. In Regular and Bubble styles the shape is responsive to Position Name length.

Choose whether text should be Black, White, or Follow Object Pen Color. This will only be available as a choice when Label Style is not Regular.

NOTE: This can cause text to render invisible eg. white text on a white background.

This will only be available as a choice when Label Style is not Regular.

Draws an extra line of text with "TRIM@ " and the z-coordinate height of the object.

A line of text for user notes.

Another line of text for user notes.

Choose left-pointing, right-pointing, or centered-line.

Engages a leader line from the object to a point set by the user with the mouse. Potentially useful if the label has to be a fair distance from the hanging position.

In addition to the size/styles in Label Style, the object can be individually scaled to user preference.

Choices: Plot, Section, or Other. Used for worksheets or Custom Selection to differentiate what the label is being used for.

If Wrap Text? is engaged, sets the width of text wrap for all text lines.

Sets the Pen color of the Label text, Label Container, and the directional arrows. Fill sets the fill of the Label Container. All other Fill/Pen attributes are dictated by the object.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box. The object's font size affects the size of the Label text. All other font attributes are dictated by the object.

Choices: None, Underline, Rectangle, or Bubble.

Choose whether text should be Black, White, or Follow Object Pen Color.

NOTE: This can cause text to render invisible eg. white text on a white background.

The text on the "West"/Left side of the label compass.

The text on the "East"/Right side of the label compass.

IF South Label is left blank the "South"/Downward arrow will not be drawn.

If not blank, adds "DIMENSION FROM: <user text>" text under compass.

If not blank, adds "NOTE: <user text>" text under compass.

User Fill/Pen affects the object. Label and Opening properties can be customized via Opening/Portal Line Style, Label Text Color, and Label Background Color parameters.

Font typeface, size, and style can be changed by altering the text attributes of the object via the Text menu or the Format Text box.

Horizontal width of the opening.

Overall height of the object.

This specifies the distance from the top of the object to the top of the portal opening.

Choices: Solid, Dashed, Dashed Spaced, Dotted, None.

Drawn depth of the object. To draw a simple line, set this to 0".

This makes no visual difference in 2D.

• Soft: Draws the 3D with a taper to the top (triangle in section).
• Hard: Draws the 3D with a square top (rectangle in section).

Allows positioning the object offset from the hanging position based on a percentage of the object's depth. For example: a scenic piece with a Depth of 2ft is hung from a batten, but 6inches are downstage of the batten and 18inches are upstage of the batten. A value of 0.25 would accomplish this while allowing the plug-in object to maintain a Y position that matches the batten.

Must be a value between 0 and 1. 0.5 sets the hang to the center of the object.

Choices: Black or Follow Object Color

Choices: White, Follow Object Color, or None (ie. no fill).

Choices: Center, Legs, or Both.

Fill/Pen attributes only affect the polyline drawing. All other Fill/Pen attributes are dictated by the object.

Font typeface and style can be changed by altering the text attributes of the object via the Text menu or the Format Text box. Text size is set by the Text Label Height parameter. All other font attributes are dictated by the object.

These values will be combined into a single label with the format:

Type of Tape (Channel) [Address]

If any field is left blank, that field and its parentheses/brackets will be excluded from the drawn label. Labels are placed at the midpoint between two polyline vertices. For curves, Cubic Spline or Radius (Point on Arc) are recommended.

This parameter is an additional field for a more detailed description of the type of tape. This information does not display on the drawing; it is mainly used for displaying in worksheet summaries.

Set text height as a dimension, eg. 2".

Sets the width of the LED Tape polyline on the drawing. If set to 0", the drawing will default to 12mm.

Note: The Tape Width parameter is a dimension. This means that you can enter a value of inches or millimeters, regardless of your document units setting. Simply type 1.5in or 12mm into the field.

Note: The Length Unit parameter is a dimension. This means that you can enter a value of feet (1') or meters (1m), regardless of your document units setting.

This is calculated by the object and can not be edited.

This is calculated by the object and can not be edited.

Sets the color of the box around the text. Gradients and Tiles may be used (eg. for RGB or CMY systems), but local settings per object are unreliable.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box. All other font attributes are dictated by the object.

Label for the lighting system (eg. Front, Side, Practicals, etc).

Label for the gel color or color-mixing method for that system of fixtures.

Note: this does not automatically change the color of the box around the text. That must be set by the Fill or Pen Attribute.

Note: A value of 1 equals 100% scale. By default the object is drawn to be 2 inches wide.

Fill may be set on a per-object basis via the VW Attribute Palette. Pen affects the text color. All other Pen attributes are set by the plug-in object.

If Style is Invert Bold, all colors will be set by the plug-in object.

Font typeface and size can be changed by altering the text attributes of the object via the Text menu or the Format Text box. All other font attributes are dictated by the object.

The channel or group number. Does support decimal values for multi-cell fixtures. The Spotlight Numbering Command can be used to automatically number this field.

A value before the channel number to allow labeling (eg. Groups) without interfering with automatic-numbering.

A value after the channel number to allow labeling without interfering with automatic-numbering.

Choices: Plain, Bold, Invert Bold

Draws a container around the number value. The container re-sizes as the value gets longer/shorter. Choices: None, Rectangle, Circle, Oval, North, South, East, West.

Places accompanying label text on the drawing for a list style magic sheet.

Choices: Black or Follow Object Color.

Choices: White or Follow Object Color.

Adjusts Label text as a percentage of the Number text size.

Choices: Right or Left.

Gap distance from Number to Label.

Sets the attributes of the frame around the Rack Object. Pen also sets the color of the Rack Name/ID text.

Font attributes of the Rack Name can be changed by altering the text attributes of the object via the Text menu or the Format Text box. The space numbers are affected by the changes in typeface, but no other attributes including size because they are scaled to fit in 1 rack space to avoid overlap.

Choices: None, Top, or Bottom

Choices: Bottom or Top

Added to the Rack label on drawing. Choices: blank, Front, Rear

Specifies the outside offset drawn from the rack spaces in inches, not the overall width or height.

Choices: None, Left, Right, Both

Sets the fill of Rack Ears or whole unit based on Object color affects attribute.

Sets the color of the text labels.

• Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box.
• Style changes (Bold, Italic, etc) affect the Manufacturer & Model but not the Purpose.
• Size will attempt to follow the user text size settings, but the plug-in will scale the text to fit inside the equipment.

Note: Uses the top of the equipment piece as its origin point.

Choices: Full, Half, Quarter, Fifth.

Half width will render a -L or -R at the end of Position in Rack depending on whether it is on the left or right side of the rack.

Quarter or Fifth will add a decimal point number to the end of Position in Rack based on left/right position.

Choices: Rack Ears Only or Entire Object

(CAN NOT BE EDITED)

Automatically finds the Rack Object it is placed in and displays its ID. Objects must be on the same layer and may not be in a Symbol.

Can be useful for Custom Selection and Worksheet displays.

(CAN NOT BE EDITED)

Automatically finds its position in the Rack Object and displays the space number. Objects must be on the same layer and may not be in a Symbol.

Can be useful for Custom Selection and Worksheet displays.

All attributes are set by the object.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box.

Choices: Console, Rack, Multi, FX Process, Mixer, DAC, Computer, Com, Amp, Other

Sets the height of the object box and dictates which parameter fields are placed on the drawing.

Choices:

• Double:Standard two columns for inputs and outputs.
• Single:One column, ideal for a Pass Thru configuration.
• Break:Draws a break line at the selected position to indicate multiple instances of this piece of equipment.
  • Bottom
  • Left
  • Right

Precedes the ID#.

Affects the size of spaces drawn under the Device header. These spaces are for placement of SBD In-Out Objects.

All attributes are set by the object.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box.

Choices: Input, Output, Header, Spacer, Thru

Precedes the ID#.

NOTE: This field is filled by the object based on the SBD Device boundary that the SBD In-Out object is placed within.

Note: This field does not appear on the drawing. It is mainly used for worksheets or Custom Selection.

Fill/Pen affects the Model label text. All other attributes are set by the object.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box.

Automatically set to 'Amp'.

SBD Amp will re-draw with the specified number of channels at Size: Regular.

Precedes the ID#.

All attributes are set by the object.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box.

Choices: Speaker, Microphone, Source.

Precedes the ID#.

Not shown on drawing.

All attributes are set by the object.

Font typeface can be changed by altering the text attributes of the object via the Text menu or the Format Text box.

Currently Flyoff is the only choice. This is being held for possible future expansion.

Choices: Regular, Small, or Micro

Note: currently Regular and Small draw the same shape on the drawing. This may have more options in a future expansion.

Precedes the ID#.

Sets all relevant pen attributes of the drawn line except for beginning & end markers.

Note: all styles adjust their sizing to fit in the geometry of their path.

Corresponds to the middle ControlPoint handle. Useful as a measurement or to type in a value when using the handle would not be most effective (eg. adjusting multiple selected lines at once).

Corresponds to the end ControlPoint handle. Useful as a measurement or to type in a value when using the handle would not be most effective (eg. adjusting multiple selected lines at once).

Sets the style of the Beginning Marker.

Choices: None, Dot, Arrow, Box

Creates multiple inputs at the beginning of the line for instances where multiple sources are combining. Use positive numbers to place duplicates above the line start point and use negative numbers to place duplicates under.

Choices: Regular, Small, Micro.

Sets the style of the Ending Marker.

Choices: None, Dot, Arrow, Box

Creates multiple inputs at the end of the line for instances where multiple sources are splitting. Use positive numbers to place duplicates above the line end point and use negative numbers to place duplicates under.

Choices: Regular, Small, Micro.

Sets all relevant pen attributes of the drawn line except for beginning & end markers.

Note: all styles adjust their sizing to fit in the geometry of their path.

Sets the style of the Beginning Marker.

Choices: None, Dot, Arrow, Box

Sets the style of the Ending Marker.

Choices: None, Dot, Arrow, Box

Fill and Pen may be set on a per-object basis via the VW Attribute Palette. Hatches, Gradients, etc. may be used, but can not have local settings per object. 3D Guide Lines receive their color from the Fill attribute, while 3D Loci receive color from the Pen attribute.

Font options can be changed by altering the text attributes of the object via the Text menu or the Format Text box. Alignment is set to Center by the object.

This will be drawn over the result points to differentiate between multiple Survey 3D objects.

Choices: 1 or 2. The 2 points can be useful when trying to describe multiple points on an object without having to re-measure. Examples would be the two ends of a hanging pipe or the two extreme sightlines of a balcony seating area.

Placement of Measure 2 from Measure 1

Placement of Measure 3 from Measure 1

Note: These values are set by the object.

Displays the coordinates of the resulting points.

• If not all necessary fields have a non-zero value, this will display Incomplete Dimensions.
• If distance measurements have incompatible values, this will display ERROR! Invalid Dimensions. The same message will be placed on the drawing in red, and red spheres will be drawn in 3D to indicate that new measurements need to be taken.

In order to be recalled by Hydra, Layers and Classes must have a Tag assigned to them with the syntax "Hydra-" followed by the single keyboard key the user wishes to use to recall that Layer or Class.

Saved Views must have "Hydra-<key>" somewhere in their name.

NOTE: Only one resource may be assigned to a particular key. Having multiple resources tagged with the same key can lead to unexpected results.

The Hydra command must be added to a menu in the workspace in order to be used. It can also have a keyboard shortcut assigned. On a Mac I've found that Command-semicolon is unused by Vectorworks and is fairly ergonomic.

The <Escape> key may be pressed at any time to cancel the command.

Type a single key to select the action to perform. This is case-insensitive.

Type a single key to select the resource (Layer, Class, Saved View) assigned to that key. If no resource is assigned, Hydra will deliver an error message.