VS:GetGableAttributes

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

Description

Procedure GetGableAttributes returns the attributes of a gable dormer in the referenced roof.

PROCEDURE GetGableAttributes(
               roofObject        :HANDLE;
               dormerID          :INTEGER;
               VAR useHeight     :BOOLEAN;
               VAR heightDepth   :REAL;
               VAR bottomWidth   :REAL;
               VAR overhang      :REAL;
               VAR leftSlope     :REAL;
               VAR rightSlope    :REAL);

def vs.GetGableAttributes(roofObject, dormerID):
    return (useHeight, heightDepth, bottomWidth, overhang, leftSlope, rightSlope)

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 width.
leftSlope		REAL		Returns left roof slope of dormer element.
rightSlope		REAL		Returns right roof slope of dormer element.

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: Set to 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.

overhang: Distance roof projects past dormer walls.

Version

Availability: from VectorWorks8.0