VS:GetHipAttributes

From Vectorworks Developer
Jump to: navigation, search

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


Description

Procedure GetHipAttributes returns the attributes of a hip dormer in the referenced roof.
PROCEDURE GetHipAttributes(
roofObject  :HANDLE;
dormerID  :INTEGER;
VAR useHeight  :BOOLEAN;
VAR heightDepth  :REAL;
VAR bottomWidth  :REAL;
VAR overhang  :REAL;
VAR leftSlope  :REAL;
VAR rightSlope  :REAL;
VAR frontSlope  :REAL);
def vs.GetHipAttributes(roofObject, dormerID):
    return (useHeight, heightDepth, bottomWidth, overhang, leftSlope, rightSlope, frontSlope)

Parameters

roofObject HANDLE Handle to roof.
dormerID INTEGER Index of dormer element.
useHeight BOOLEAN Returns if height setting was used to created dormer.
heightDepth REAL Returns height or depth value.
bottomWidth REAL Returns bottom width.
overhang REAL Returns overhang distance.
leftSlope REAL Returns slope of left roof.
rightSlope REAL Returns slope of right roof.
frontSlope REAL Returns slope of front roof.

Remarks

This will fail if the dormerID identifies a dormer of a different style, or the dormerID is not valid.

dormerID: Identifies the dormer for which to retrieve the information.

useHeight: true if the next value is the height of the dormer, if false, next value is the depth (front to back) of the dormer heightDepthValue: size of the dormer, either by height or depth; determined by previous parameter

bottomWidth: Dimension of bottom front edge of the dormer, left to right.

leftSlope: Angle of left dormer roof. rightSlope: Angle of right dormer roof. frontSlope: Angle of the front dormer roof face.

overhang: Distance roof projects past dormer walls.

Version

Availability: from VectorWorks8.0
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox