VS:SetHipAttributes

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

Description

Procedure SetHipAttributes sets the attributes of a hip dormer in the referenced roof.

PROCEDURE SetHipAttributes(
              roofObject            :HANDLE;
              dormerID              :INTEGER;
              useHeight             :BOOLEAN;
              heightDepthDistance   :REAL;
              bottomWidthDistance   :REAL;
              overhangDistance      :REAL;
              leftAngle             :REAL;
              rightAngle            :REAL;
              frontAngle            :REAL);

def vs.SetHipAttributes(roofObject, dormerID, useHeight, heightDepthDistance, bottomWidthDistance, overhangDistance, leftAngle, rightAngle, frontAngle):
    return None

Parameters

roofObject	HANDLE	Handle to roof.
dormerID	INTEGER	Index of dormer element.
useHeight	BOOLEAN	Use height setting to create dormer element.
heightDepthDistance	REAL	Height/depth distance.
bottomWidthDistance	REAL	Bottom width.
overhangDistance	REAL	Overhang distance.
leftAngle	REAL	Slope of left roof of dormer.
rightAngle	REAL	Slope of right roof of dormer.
frontAngle	REAL	Slope of front roof of dormer.

Remarks

dormerID: Identifies the dormer for which to set 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. frontSlope: Angle of the front dormer roof face.

overhang: Distance roof projects past dormer walls.

Example

Template:CreateRoofOb

Version

Availability: from VectorWorks8.0