VS:UpdateSymbolDisplayControl

From Vectorworks Developer
Jump to: navigation, search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Updates a pre-existing symbol display control in the dialog with a new symbol, rendering mode, or view. The dialog ID and item ID must refer to symbol display control created with CreateSymbolDisplayControl. To show a blank SymbolDisplay control, use an empty string as the symbolName parameter.
Table - Render Modes
Render Mode Constant
Wireframe 0
Unshaded Polygon 2
Shaded Polygon 3
Shaded Polygon No Lines 4
Final Shaded Polygon 5
Hidden Line 6
Dashed Hidden Line 7
OpenGL 11
Fast RenderWorks 12
Fast RenderWorks with Shadows 13
Final Quality RenderWorks 14
Custom RenderWorks 15
Artistic RenderWorks 17
Sketch 18


Table - Views
View Constant
Top/Plan 2
Front 3
Back 4
Left 5
Right 6
Top 7
Bottom 8
Right Isometric 9
Left Isometric 10
Right Rear Isometric 11
Left Rear Isometric 12
Bottom Right Isometric 13
Bottom Left Isometric 14
Bottom Right Rear Isometric 15
Bottom Left Rear Isometric 16
PROCEDURE UpdateSymbolDisplayControl(
dialogID  :LONGINT;
itemID  :LONGINT;
symbolName  :STRING;
renderMode  :INTEGER;
view  :INTEGER);
def vs.UpdateSymbolDisplayControl(dialogID, itemID, symbolName, renderMode, view):
    return None

Parameters

dialogID LONGINT The ID of the dialog in which to create the control.
itemID LONGINT The item ID of the control.
symbolName STRING The name of the symbol to display.
renderMode INTEGER The render mode in which to display the symbol.
view INTEGER The standard view in which to display the symbol.

Example

VectorScript

CreateSymbolDisplayControl( 5, 6, 'Chair', 350, 200, 5, 11, 9 );
{Other code}
UpdateSymbolDisplayControl( 5, 6, 'Chair', 0, 3 );

This creates a dialog control that displays the symbol called "Chair."  The control is 350 pixels high AND 200 pixels wide, WITH a margin OF 5 pixels.  The symbol is rendered IN OpenGL mode AND displayed IN a right isometric view.  It THEN later updates the control TO display the same symbol rendered IN Wireframe IN a front view.

Python


Version

Availability: from VectorWorks 12.0

See Also

VS Functions:

VS:CreateSymbolDisplayControl

VS Functions: [[VS:CreateSymbolDisplayControl]]
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox