AppendRoofEdge Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   AppendRoofEdge
(   theRoof :HANDLE;
    edgePtX :REAL;
    edgePtY :REAL;
    slopeAngle :REAL;
    projectionDistance :REAL (Coordinate);
    eaveHeightDistance :REAL (Coordinate)
) ;

Python:

def  vs.AppendRoofEdge(theRoof, edgePt, slopeAngle, projectionDistance, eaveHeightDistance):
   return None

Description:

Function AppendRoofEdge creates a new edge in the referenced roof object.

説明

ハンドルで指定した屋根に、新しい縁を追加します。

Parameters:

theRoof Handle to roof. 屋根のハンドル
edgePt Definition point of roof edge. 屋根の縁の座標
slopeAngle Slope of roof edge. 傾斜角度
projectionDistance Eave overhang. 軒の張り出し距離
eaveHeightDistance Eave height. 軒の高さ

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45d0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45d0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45d0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45d0'0",2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8d0'0");
SetDormerAttributes(roofHandle, shedID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  BeginRoof Objects - Roofs 
MiniCAD4.0

VectorScript Declaration:

PROCEDURE   BeginRoof
(   p1X :REAL;
    p1Y :REAL;
    p2X :REAL;
    p2Y :REAL;
    upslopeX :REAL;
    upslopeY :REAL;
    riseDistance :REAL (Coordinate);
    runDistance :REAL (Coordinate);
    miter :INTEGER;
    vertPart :REAL
) ;

Python:

def  vs.BeginRoof(p1, p2, upslope, riseDistance, runDistance, miter, vertPart):
   return None

Description:

Procedure BeginRoof creates a simple roof object in a Vectorworks document.

Table - Roof Miter Styles

Miter Style Constant
Vertical 1
Horizontal 2
Double

3
Square

4


3-D View of Roof




説明

この手続きを実行してから、EndGroupが実行されるまでに作成された2次元図形を平面とする屋根を作成します。

Parameters:

p1 Coordinates of roof axis start point. 屋根の座標軸の始点
p2 Coordinates of roof axis end point. 屋根の座標軸の終点
upslope Coordinates of upslope definition point. 勾配定義の開始点の座標
riseDistance Rise distance. 高さ
runDistance Run distance. 水平距離
miter Edge miter style of roof. 端部の形状
vertPart Dimension of vertical miter for double miter style. 端部が垂直と水平の時の垂直の寸法

Example:

BeginRoof(1,1,5,1,2,2,0.5,1,1,0);
  ClosePoly;
  Poly(1,1,3,1,3.5,2,4,1,5,1,5,5,1,5);
EndGroup;



  ConvToUnstyledRoof Objects - Roofs 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   ConvToUnstyledRoof
( roof:HANDLE ) ;

Python:

def  vs.ConvToUnstyledRoof(roof):
   return None

Description:

Sets a roof to be unstyled.

説明

屋根を スタイルなし に設定します。

Parameters:

roof The roof. 屋根のハンドル



  CreateBatDormer Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   CreateBatDormer
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.CreateBatDormer(roofObject):
   return INTEGER

Description:

Function CreateBatDormer creates a bat dormer in the referenced roof object.

説明

ハンドルで指定した屋根に、波形のドーマーを追加します。

Parameters:

roofObject Handle to roof. 屋根のハンドル

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
batID := CreateBatDormer(roofHandle);
SetBatAttributes(roofHandle,batID,TRUE,5'0",10'0",4'0",6'3",2'0",#8°0'0");
SetDormerAttributes(roofHandle,batID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateGableDormer Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   CreateGableDormer
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.CreateGableDormer(roofObject):
   return INTEGER

Description:

Function CreateGableDormer creates a gable dormer in the referenced roof object.

説明

ハンドルで指定した屋根に、切り妻のドーマーを追加します。

Parameters:

roofObject Handle to roof. 屋根のハンドル

Example:

roofHandle:=CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
gabID:=CreateGableDormer(roofHandle);
SetGableAttributes(roofHandle,gabID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle,gabID,3,18'4",TRUE,3'0",63,FALSE,
3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateHipDormer Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   CreateHipDormer
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.CreateHipDormer(roofObject):
   return INTEGER

Description:

Function CreateHipDormer creates a hip dormer in the referenced roof object.

説明

ハンドルで指定した屋根に、寄せ棟のドーマーを追加します。

Parameters:

roofObject Handle to roof. 屋根のハンドル

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle, -77'10",21'4.81922",#45°0'0",2'0",10'0");
hID := CreateHipDormer(roofHandle);
SetHipAttributes(roofHandle, hID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle,hID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateRoof Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   CreateRoof
(   genGableWall :BOOLEAN;
    bearingInsetDistance :REAL (Coordinate);
    roofThickDistance :REAL (Coordinate);
    miterType :INTEGER;
    vertMiterDistance :REAL (Coordinate)
) :HANDLE ;

Python:

def  vs.CreateRoof(genGableWall, bearingInsetDistance, roofThickDistance, miterType, vertMiterDistance):
   return HANDLE

Description:

Function CreateRoof creates a new roof object in a Vectorworks document, returning a handle to the object. To define the roof object template, use AppendRoofEdge.

Table - Roof Miter Styles

Miter Style Constant
Vertical 1
Horizontal 2
Double

3
Square

4

説明

新しい屋根を作成し、そのハンドルを返します。

Parameters:

genGableWall Specifies gable roof generation. 切り妻の有無
bearingInsetDistance Bearing inset distance of wall into roof. 壁からの距離
roofThickDistance Roof thickness. 屋根の厚み
miterType Miter style of roof. 切り妻の種類
vertMiterDistance Vertical component for double miters. 切り妻の高さ

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,0");
AppendRoofEdge(roofHandle, -87'4",-38'4",#45d 0' 0" ,2'0",10'0");
AppendRoofEdge(roofHandle, -30'2",-38'4",#45d 0' 0" ,2'0",10'0");
AppendRoofEdge(roofHandle, -30'2",45'10",#45d 0' 0" ,2'0",10'0");
AppendRoofEdge(roofHandle, -87'4",45'10",#45d 0' 0" ,2'0",10'0");

See Also:

AppendRoofEdge  



  CreateShedDormer Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   CreateShedDormer
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.CreateShedDormer(roofObject):
   return INTEGER

Description:

Function CreateShedDormer creates a shed dormer in the referenced roof object.

説明

ハンドルで指定した屋根に、片流れのドーマーを追加します。

Parameters:

roofObject Handle to roof. 屋根のハンドル

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
shedID:=CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle,shedID,3,18'4",TRUE,3'0",63,FALSE, 3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateSkylight Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   CreateSkylight
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.CreateSkylight(roofObject):
   return INTEGER

Description:

Function CreateSkylight creates a new skylight in the referenced roof object.

説明

ハンドルで指定した屋根に、天窓を追加します。

Parameters:

roofObject Handle to roof. 屋根のハンドル

Example:

skylightID:=CreateSkylight(roofHandle);
SetSkylight(roofHandle,skylightID,6,13'8",2'1",Name2Index('dh2436'));



  CreateTrapeziumDormer Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   CreateTrapeziumDormer
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.CreateTrapeziumDormer(roofObject):
   return INTEGER

Description:

Function CreateTrapeziumDormer creates a trapezium dormer in the referenced roof object.

説明

ハンドルで指定した屋根に、台形のドーマーを追加します。

Parameters:

roofObject Handle to roof. 屋根のハンドル

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle, -77'10",21'4.81922",#45°0'0",2'0",10'0");
trapID:=CreateTrapeziumDormer(roofHandle);
SetTrapeziumAttributes(roofHandle,trapID,TRUE,6'0",10'0",TRUE,6'0",#0°0'0",#0°0'0",#8°0'0");
SetDormerAttributes(roofHandle,trapID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  GetBatAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetBatAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  topWidth :REAL;
  VAR  baseHeight :REAL;
  VAR  controlPoint :REAL;
  VAR  topSlope :REAL
) ;

Python:

def  vs.GetBatAttributes(roofObject, dormerID):
   return (useHeight, heightDepth, bottomWidth, topWidth, baseHeight, controlPoint, topSlope)

Description:

Procedure GetBatAttributes returns the attributes of a bat dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、波型のドーマーの情報を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Returns if height setting was used to created dormer. 高さ設定の有無
heightDepth Returns height or depth value. 高さまたは厚み
bottomWidth Returns bottom width. 下部の幅
topWidth Returns top width. 上部の幅
baseHeight Returns base height. 高さ
controlPoint Returns the control point offset. 制御点の位置
topSlope Returns the slope of the bat roof. 傾斜角度



  GetDormerAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetDormerAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
  VAR  edgeIndex :INTEGER;
  VAR  cornerOffset :REAL;
  VAR  isPerpOffset :BOOLEAN;
  VAR  perpOrHeightOffset :REAL;
  VAR  symName :LONGINT;
  VAR  centerSymbol :BOOLEAN;
  VAR  symOffset :REAL
) ;

Python:

def  vs.GetDormerAttributes(roofObject, dormerID):
   return (edgeIndex, cornerOffset, isPerpOffset, perpOrHeightOffset, symName, centerSymbol, symOffset)

Description:

Procedure GetDormerAttributes returns the attributes of a roof element in the referenced roof.

説明

ハンドルで指定した屋根の中の、ドーマーの情報を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
edgeIndex Index of roof edge. 縁の番号
cornerOffset Returns offset from roof edge corner. 縁の隅からの距離
isPerpOffset Returns whether perpendicular offset was used. 垂直指定の場合はTRUE
perpOrHeightOffset Returns perpendicualr or height offset. 垂直または高さ
symName Returns index of dormer symbol. シンボルの番号
centerSymbol Returns whether symbol was centered. シンボルが中心の場合はTRUE
symOffset Returns symbol offset distance. シンボルのずれ

See Also:

Index2Name  



  GetDormerThick Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetDormerThick
(   roofObject :HANDLE;
  VAR  wallThick :REAL;
  VAR  roofThick :REAL
) ;

Python:

def  vs.GetDormerThick(roofObject):
   return (wallThick, roofThick)

Description:

Procedure GetDormerThick returns dormer roof and wall thicknesses for the referenced roof.

説明

ハンドルで指定したドーマーの、壁と屋根の厚みを返します。

Parameters:

roofObject Handle to dormer. ドーマーのハンドル
wallThick Returns dormer wall thickness. 壁の厚み
roofThick Returns dormer roof thickness. 屋根の厚み



  GetGableAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

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

Python:

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

Description:

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

説明

ハンドルで指定した屋根の中の、切り妻のドーマーの情報を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Returns if height setting was used to created dormer. 高さ設定の有無
heightDepth Returns height or depth value. 高さまたは厚み
bottomWidth Returns bottom width. 下部の幅
overhang Returns overhang width. 張り出し距離
leftSlope Returns left roof slope of dormer element. 左側の傾斜角度
rightSlope Returns right roof slope of dormer element. 右側の傾斜角度



  GetHipAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

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
) ;

Python:

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

Description:

Procedure GetHipAttributes returns the attributes of a hip dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、寄せ棟のドーマーの情報を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Returns if height setting was used to created dormer. 高さ設定の有無
heightDepth Returns height or depth value. 高さまたは厚み
bottomWidth Returns bottom width. 下部の幅
overhang Returns overhang distance. 張り出し距離
leftSlope Returns slope of left roof. 左側の傾斜角度
rightSlope Returns slope of right roof. 右側の傾斜角度
frontSlope Returns slope of front roof. 前側の傾斜角度



  GetNumRoofElements Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetNumRoofElements
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.GetNumRoofElements(roofObject):
   return INTEGER

Description:

Function GetNumRoofElements returns the number of roof elements (dormers and skylights) in the referenced roof object.

説明

ハンドルで指定した屋根の中の、ドーマーの数を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル



  GetRoofAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetRoofAttributes
(   theRoof :HANDLE;
  VAR  genGableWall :BOOLEAN;
  VAR  bearingInset :REAL;
  VAR  roofThick :REAL;
  VAR  miterType :INTEGER;
  VAR  vertMiter :REAL
) :BOOLEAN ;

Python:

def  vs.GetRoofAttributes(theRoof):
   return (BOOLEAN, genGableWall, bearingInset, roofThick, miterType, vertMiter)

Description:

Function GetRoofAttributes returns the attributes of the referenced roof object.

Table - Roof Miter Styles

Miter Style Constant
Vertical 1
Horizontal 2
Double

3
Square

4

説明

ハンドルで指定した屋根の情報を返します。

Parameters:

theRoof Handle to roof object. 屋根のハンドル
genGableWall Returns gable wall generation state. 切り妻の有無
bearingInset Returns bearing inset dimension. 壁からの距離
roofThick Returns roof thickness. 屋根の厚み
miterType Returns miter style. 切り妻の種類
vertMiter Returns vertical miter dimension. 切り妻の高さ

Example:

PROCEDURE Example;
var
	theRoof :HANDLE;
	genGableWall :BOOLEAN; 
	bearingInset, roofThick :REAL; 
	miterType :INTEGER; 
	vertMiter :REAL;
begin
	theRoof := FSActLayer;
	IF GetRoofAttributes(theRoof, genGableWall, bearingInset, roofThick, miterType, vertMiter)
	THEN Message(genGableWall, ' ', bearingInset, ' ', roofThick, ' ', miterType, ' ', vertMiter);
end;
RUN(Example);



  GetRoofEdge Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetRoofEdge
(   theRoof :HANDLE;
    index :INTEGER;
  VAR  vertexPtX :REAL;
  VAR  vertexPtY :REAL;
  VAR  slope :REAL;
  VAR  projection :REAL;
  VAR  eaveHeight :REAL
) :BOOLEAN ;

Python:

def  vs.GetRoofEdge(theRoof, index):
   return (BOOLEAN, vertexPt, slope, projection, eaveHeight)

Description:

Procedure GetRoofEdge returns the definition attributes of a roof edge for the referenced roof object.

説明

ハンドルで指定した屋根の中の、番号で指定した縁の情報を返します。

Parameters:

theRoof Handle to roof. 屋根のハンドル
index Index of roof edge (in a range of 1 - n). 縁の番号（1からnの範囲）
vertexPt Returns coordinates of roof edge definition vertex. 屋根の縁の座標
slope Returns slope of roof edge. 傾斜角度
projection Retunrs eave overhang dimension. 軒の張り出し距離
eaveHeight Returns eave height. 軒の高さ



  GetRoofElementType Objects - Roofs 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetRoofElementType
(   roofObject :HANDLE;
    dormerID :INTEGER;
  VAR  edgeIndex :INTEGER;
  VAR  isDormer :BOOLEAN;
  VAR  dormerType :INTEGER
) ;

Python:

def  vs.GetRoofElementType(roofObject, dormerID):
   return (edgeIndex, isDormer, dormerType)

Description:

Returns information on the specified roof element. The dormer type value is one of the following: 1 for Trapezium Dormer, 2 for Saddle Dormer, 3 for Shed Dormer, 4 for Slope Dormer, 5 for Bat Dormer.

説明

ハンドルで指定した屋根の情報を返します。

Parameters:

roofObject Handle to roof object. 屋根のハンドル
dormerID Index of roof element. 屋根の番号
edgeIndex Index of roof edge associated with roof element (1-based index). 屋根の辺番号（1から）
isDormer True if this element is a dormer, false if it is a skylight. 屋根窓の場合はTRUE
dormerType Type of dormer roof element. 屋根窓の種類



  GetRoofFaceAttrib Objects - Roofs 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetRoofFaceAttrib
(   roofFace :HANDLE;
  VAR  roofRise :REAL;
  VAR  roofRun :REAL;
  VAR  miterType :INTEGER;
  VAR  holeStyle :INTEGER;
  VAR  vertPart :REAL;
  VAR  thickness :REAL
) ;

Python:

def  vs.GetRoofFaceAttrib(roofFace):
   return (roofRise, roofRun, miterType, holeStyle, vertPart, thickness)

Description:

Returns information on the referenced roof face object.

Table - Roof Miter Styles

Miter Style Constant
Vertical 1
Horizontal 2
Double

3
Square

4

説明

ハンドルで指定した屋根の属性を返します。

Parameters:

roofFace Handle to roof face object. 屋根のハンドル
roofRise Rise of roof. 上方への距離
roofRun Run of roof. 前方への距離
miterType Miter style of roof. 端部の形状
holeStyle Miter style of openings. 穴の種類
vertPart Vertical component of compound miters. 垂直方向の厚み
thickness Thickness of roof. 屋根の厚み

Example:

PROCEDURE Example;

PROCEDURE ShowRoofFaceAttrib(roofFace :HANDLE);
VAR
	roofRise, roofRun :REAL; 
	miterType, holeStyle :INTEGER; 
	vertPart, thickness :REAL;
BEGIN
	IF GetObjectVariableInt(roofFace, 172) = 1 THEN BEGIN
		GetRoofFaceAttrib(roofFace, roofRise, roofRun, miterType, holeStyle, vertPart, thickness);
		Message('roofRise: ', roofRise,
			',  roofRun: ', roofRun,
			',  miterType: ', miterType,
			',  holeStyle: ', holeStyle,
			',  vertPart: ', vertPart,
			',  thickness: ', thickness);
	END;
END;

BEGIN
	ForEachObject(ShowRoofFaceAttrib, ((SEL=TRUE)&(T=71)));
END;
RUN(Example);



  GetRoofFaceCoords Objects - Roofs 
VectorWorks9.0

VectorScript Declaration:

PROCEDURE   GetRoofFaceCoords
(   h :HANDLE;
  VAR  axis1X :REAL;
  VAR  axis1Y :REAL;
  VAR  axis2X :REAL;
  VAR  axis2Y :REAL;
  VAR  Zaxis :REAL;
  VAR  upslopeX :REAL;
  VAR  upslopeY :REAL
) ;

Python:

def  vs.GetRoofFaceCoords(h):
   return (axis1, axis2, Zaxis, upslope)

Description:

Returns the coordinates of the defining geometry of a roof face.

説明

ハンドルで指定した屋根の傾きを取得します。

Parameters:

h Handle to roof face object. 屋根のハンドル
axis1 X-Y coordinates of first axis point. 最初の軸の座標
axis2 X-Y coordinates of second axis point. 2番目の軸の座標
Zaxis Elevation of roof axis. 高さ
upslope X-Y coordinates of roof upslope point. X軸、Y軸のスロープ距離

Example:

PROCEDURE GetRoofFaceCoordsExample;

PROCEDURE MarkCoords(h :HANDLE);
VAR
	beg_pt, end_pt, upslope_pt :VECTOR;
	Z :REAL;
BEGIN
	IF GetObjectVariableInt(h, 172) = 1 THEN BEGIN
		GetRoofFaceCoords(h, beg_pt.x, beg_pt.y, end_pt.x, end_pt.y, Z, upslope_pt.x, upslope_pt.y);
		beg_pt     := beg_pt     * (25.4 / GetPrefReal(152));
		end_pt     := end_pt     * (25.4 / GetPrefReal(152));
		upslope_pt := upslope_pt * (25.4 / GetPrefReal(152));
		Locus(beg_pt.x, beg_pt.y);
		Locus(end_pt.x, end_pt.y);
		Locus(upslope_pt.x, upslope_pt.y);
	END;
END;

BEGIN
	ForEachObject(MarkCoords, (T=71));
END;
RUN(GetRoofFaceCoordsExample);



  GetRoofStyle Objects - Roofs 
Vectorworks 2016

VectorScript Declaration:

FUNCTION   GetRoofStyle
( roof:HANDLE ) :LONGINT ;

Python:

def  vs.GetRoofStyle(roof):
   return LONGINT

Description:

Gets the Roof Style of a roof.

説明

屋根の屋根スタイルを返します。

Parameters:

roof The roof. 屋根のハンドル

Result:

The ref number of the Roof Style of the roof. 0 for unstyled.

返り値

屋根の屋根スタイルの参照番号。スタイルなしの場合は0

See Also:

SetRoofStyle  



  GetRoofVertices Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   GetRoofVertices
( roofObject:HANDLE ) :INTEGER ;

Python:

def  vs.GetRoofVertices(roofObject):
   return INTEGER

Description:

Function GetRoofVertices returns the number of roof edges in the referenced roof object.

説明

ハンドルで指定した屋根が持つ、縁の数を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル



  GetShedAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetShedAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  overhang :REAL;
  VAR  topSlope :REAL
) ;

Python:

def  vs.GetShedAttributes(roofObject, dormerID):
   return (useHeight, heightDepth, bottomWidth, overhang, topSlope)

Description:

Procedure GetShedAttributes returns the attributes of a shed dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、片流れのドーマーの情報を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Returns if height setting was used to created dormer. 高さ設定の有無
heightDepth Returns height or depth value. 高さまたは厚み
bottomWidth Returns bottom width. 下部の幅
overhang Returns overhang distance. 張り出し距離
topSlope Returns top slope of dormer roof. 上側の傾斜角度



  GetSkylight Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetSkylight
(   roofObject :HANDLE;
    skylightID :INTEGER;
  VAR  edgeIndex :INTEGER;
  VAR  cornerOffset :REAL;
  VAR  perpOffset :REAL;
  VAR  symName :LONGINT
) ;

Python:

def  vs.GetSkylight(roofObject, skylightID):
   return (edgeIndex, cornerOffset, perpOffset, symName)

Description:

Function GetSkylight returns the definition attributes of a specified skylight in the referenced roof object.

説明

ハンドルで指定した屋根の中の、天窓の情報を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
skylightID Index of skylight element. ドーマーの番号
edgeIndex Index of roof edge associated with skylight. 縁の番号
cornerOffset Offset of skylight from corner. 縁の隅からの距離
perpOffset Offset of skylight from roof edge. 垂線の高さ
symName Name of skylight symbol. シンボルの番号

Example:

GetSkylight(roofHandle,skylightID,edgeID,cOff,pOff,symID);
symbolName:=Index2Name(symID);

See Also:

Index2Name  



  GetTrapeziumAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   GetTrapeziumAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  useTopWidth :BOOLEAN;
  VAR  topWidth :REAL;
  VAR  leftSlope :REAL;
  VAR  rightSlope :REAL;
  VAR  topSlope :REAL
) ;

Python:

def  vs.GetTrapeziumAttributes(roofObject, dormerID):
   return (useHeight, heightDepth, bottomWidth, useTopWidth, topWidth, leftSlope, rightSlope, topSlope)

Description:

Procedure GetTrapeziumAttributes returns the attributes of a trapezium dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、台形のドーマーの情報を返します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Returns if height setting was used to created dormer. 高さ設定の有無
heightDepth Returns height or depth value. 高さまたは厚み
bottomWidth Returns bottom width. 下部の幅
useTopWidth Returns whether top width was used to create dormer. 上部の幅の有無
topWidth Returns top width. 上部の幅
leftSlope Returns left slope of dormer roof. 左側の傾斜角度
rightSlope Returns right slope of dormer roof. 右側の傾斜角度
topSlope Returns top slope of dormer roof. 上側の傾斜角度



  RemoveRoofEdge Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   RemoveRoofEdge
(   roofObject :HANDLE;
    index :INTEGER
) :BOOLEAN ;

Python:

def  vs.RemoveRoofEdge(roofObject, index):
   return BOOLEAN

Description:

Function RemoveRoofEdge removes the specified roof edge from the referenced roof object.

説明

ハンドルで指定した屋根の中の、番号で指定した縁を削除します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
index Index of roof edge to be removed. 縁の番号

返り値

削除できた時はTRUE



  RemoveRoofElement Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   RemoveRoofElement
(   roofObject :HANDLE;
    id :INTEGER
) ;

Python:

def  vs.RemoveRoofElement(roofObject, id):
   return None

Description:

Procedure RemoveRoofElement removes the specified roof element from the referenced roof.

説明

ハンドルで指定した屋根の中の、番号で指定したドーマーを削除します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
id Index of dormer element. ドーマーの番号



  SetBatAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetBatAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDepthValueDistance :REAL (Coordinate);
    bottomWidthDistance :REAL (Coordinate);
    topWidthDistance :REAL (Coordinate);
    baseHeightDistance :REAL (Coordinate);
    controlPointDistance :REAL (Coordinate);
    topAngle :REAL
) ;

Python:

def  vs.SetBatAttributes(roofObject, dormerID, useHeight, heightDepthValueDistance, bottomWidthDistance, topWidthDistance, baseHeightDistance, controlPointDistance, topAngle):
   return None

Description:

Procedure SetBatAttributes sets the attributes of a bat dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、波形のドーマーを設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Use height setting to create dormer element. 高さ設定の有無
heightDepthValueDistance Height/depth distance. 高さまたは厚み
bottomWidthDistance Bottom width. 下部の幅
topWidthDistance Top width. 上部の幅
baseHeightDistance Base height of bat. 高さ
controlPointDistance Offset distance of control point. 制御点の位置
topAngle Slope of bat roof. 傾斜角度

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
batID := CreateBatDormer(roofHandle);
SetBatAttributes(roofHandle,batID,TRUE,5'0",10'0",4'0",6'3",2'0",#8°0'0");
SetDormerAttributes(roofHandle,batID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetDormerAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetDormerAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
    edgeIndex :INTEGER;
    cornerOffsetDistance :REAL (Coordinate);
    isPerpOffset :BOOLEAN;
    perpOrHeightOffsetDistance :REAL (Coordinate);
    symName :LONGINT;
    centerSymbol :BOOLEAN;
    symOffsetDistance :REAL (Coordinate)
) ;

Python:

def  vs.SetDormerAttributes(roofObject, dormerID, edgeIndex, cornerOffsetDistance, isPerpOffset, perpOrHeightOffsetDistance, symName, centerSymbol, symOffsetDistance):
   return None

Description:

Procedure SetDormerAttributes sets the attributes of a roof element in the referenced roof.

説明

ハンドルで指定した屋根の中の、ドーマーを設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
edgeIndex Index of roof edge. 縁の番号
cornerOffsetDistance Corner offset distance. 縁の隅からの距離
isPerpOffset Specifies perpendicular or height offset. 垂直指定の場合はTRUE
perpOrHeightOffsetDistance Perpendicular or height offset distance. 垂直または高さ
symName Index of dormer symbol. シンボルの番号
centerSymbol Specifies if symbol is centered. シンボルが中心の場合はTRUE
symOffsetDistance Symbol offset distance. シンボルのずれ

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle, shedID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetDormerThick Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetDormerThick
(   roofObject :HANDLE;
    wallThickDistance :REAL (Coordinate);
    roofThickDistance :REAL (Coordinate)
) ;

Python:

def  vs.SetDormerThick(roofObject, wallThickDistance, roofThickDistance):
   return None

Description:

Procedure SetDormerThick sets dormer roof and wall thicknesses for the referenced roof.

説明

ハンドルで指定したドーマーの、壁と屋根の厚みを設定します。

Parameters:

roofObject Handle to roof. ドーマーのハンドル
wallThickDistance Wall thickness of dormer. 壁の厚み
roofThickDistance Roof thickness of dormer. 屋根の厚み

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle, shedID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetGableAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

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

Python:

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

Description:

Procedure SetGableAttributes sets the attributes of a gable dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、切り妻のドーマーを設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Use height setting to create dormer element. 高さ設定の有無
heightDepthDistance Height/depth distance. 高さまたは厚み
bottomWidthDistance Bottom width. 下部の幅
overhangDistance Overhang distance. 張り出し距離
leftAngle Slope of left roof. 左側の傾斜角度
rightAngle Slope of right roof. 右側の傾斜角度

Example:

roofHandle:=CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
gabID:=CreateGableDormer(roofHandle);
SetGableAttributes(roofHandle,gabID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle,gabID,3,18'4",TRUE,3'0",63,FALSE,
3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetHipAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

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

Python:

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

Description:

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

説明

ハンドルで指定した屋根の中の、寄せ棟のドーマーを設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Use height setting to create dormer element. 高さ設定の有無
heightDepthDistance Height/depth distance. 高さまたは厚み
bottomWidthDistance Bottom width. 下部の幅
overhangDistance Overhang distance. 張り出し距離
leftAngle Slope of left roof of dormer. 左側の傾斜角度
rightAngle Slope of right roof of dormer. 右側の傾斜角度
frontAngle Slope of front roof of dormer. 前側の傾斜角度

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
hipID := CreateHipDormer(roofHandle);
SetHipAttributes(roofHandle, hipID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle, hipID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetRoofAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetRoofAttributes
(   roofObject :HANDLE;
    genGableWall :BOOLEAN;
    bearingInsetDistance :REAL (Coordinate);
    roofThickDistance :REAL (Coordinate);
    miterType :INTEGER;
    vertMiterDistance :REAL (Coordinate)
) ;

Python:

def  vs.SetRoofAttributes(roofObject, genGableWall, bearingInsetDistance, roofThickDistance, miterType, vertMiterDistance):
   return None

Description:

Function SetRoofAttributes sets the definition attributes of a roof object in a Vectorworks document.

Table - Roof Miter Styles

Miter Style Constant
Vertical 1
Horizontal 2
Double

3
Square

4

説明

ハンドルで指定した屋根を設定します。

Parameters:

roofObject Handle to roof . 屋根のハンドル
genGableWall Sets gable roof generation mode. 切り妻の有無
bearingInsetDistance Sets bearing inset distance. 壁からの距離
roofThickDistance Sets roof thickness. 屋根の厚み
miterType Sets miter style. 切り妻の種類
vertMiterDistance Specifies vertical miter dimension. 切り妻の高さ

Example:

PROCEDURE Example;
VAR
	thickness :REAL;
	str	:STRING;

PROCEDURE SetIt(h :HANDLE);
BEGIN
	IF GetObjectVariableInt(h, 172) = 1 THEN 
		SetObjectVariableReal(h, 170, thickness * 25.4);
END;

PROCEDURE FindRoofFaces(h :HANDLE);
VAR
	temp_h :HANDLE;
	roofObject :HANDLE; 
	genGableWall :BOOLEAN; 
	bearingInsetDistance, roofThickDistance :REAL; 
	miterType :INTEGER; 
	vertMiterDistance :REAL;
BEGIN
	IF GetType(h) = 71 THEN SetIt(h) ELSE
	IF GetRoofAttributes(h, genGableWall, bearingInsetDistance, roofThickDistance, miterType, vertMiterDistance) THEN
		SetRoofAttributes(h, genGableWall, bearingInsetDistance, thickness, miterType, vertMiterDistance);
END;

BEGIN
	thickness := RealDialog('Enter desired thickness', '10');
	str := Concat('((T=71) | (T=83)) & (L=''', GetLName(ActLayer), ''')');
	ForEachObject(FindRoofFaces, str);
END;
RUN(Example);



  SetRoofEdge Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetRoofEdge
(   roofObject :HANDLE;
    index :INTEGER;
    vertexPtX :REAL;
    vertexPtY :REAL;
    edgeAngle :REAL;
    projectionDistance :REAL (Coordinate);
    eaveHeightDistance :REAL (Coordinate)
) ;

Python:

def  vs.SetRoofEdge(roofObject, index, vertexPt, edgeAngle, projectionDistance, eaveHeightDistance):
   return None

Description:

Procedure SetRoofEdge sets the definition attributes of a roof edge for the referenced roof object.

説明

ハンドルで指定した屋根の中の、縁を設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
index Index of roof edge. 縁の番号
vertexPt Coordinates of roof edge vertex. 屋根の縁のX、Y座標
edgeAngle Roof slope. 傾斜角度
projectionDistance Eave overhang. 軒の張り出し距離
eaveHeightDistance Eave height. 軒の高さ



  SetRoofStyle Objects - Roofs 
Vectorworks 2016

VectorScript Declaration:

PROCEDURE   SetRoofStyle
(   roof :HANDLE;
    roofStyle :LONGINT
) ;

Python:

def  vs.SetRoofStyle(roof, roofStyle):
   return None

Description:

Sets the Roof Style of a roof.

説明

屋根の屋根スタイルを設定します。

Parameters:

roof The roof. 屋根のハンドル
roofStyle The Roof Style. 屋根スタイル

See Also:

GetRoofStyle  



  SetShedAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetShedAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDepthDistance :REAL (Coordinate);
    bottomWidthDistance :REAL (Coordinate);
    overhangDistance :REAL (Coordinate);
    topAngle :REAL
) ;

Python:

def  vs.SetShedAttributes(roofObject, dormerID, useHeight, heightDepthDistance, bottomWidthDistance, overhangDistance, topAngle):
   return None

Description:

Procedure SetShedAttributes sets the attributes of a shed dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、片流れのドーマーを設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Use height setting to create dormer element. 高さ設定の有無
heightDepthDistance Height/depth distance. 高さまたは厚み
bottomWidthDistance Bottom width. 下部の幅
overhangDistance Overhang distance. 張り出し距離
topAngle Top angle of dormer element. 上側の傾斜角度

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle,shedID,3,18'4",TRUE,3'0",63,FALSE, 3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetSkylight Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetSkylight
(   roofObject :HANDLE;
    skylightID :INTEGER;
    edgeIndex :INTEGER;
    cornerOffsetDistance :REAL (Coordinate);
    perpOffsetDistance :REAL (Coordinate);
    symName :LONGINT
) ;

Python:

def  vs.SetSkylight(roofObject, skylightID, edgeIndex, cornerOffsetDistance, perpOffsetDistance, symName):
   return None

Description:

Function SetSkylight sets the definition attributes of a skylight in the referenced roof object.

説明

ハンドルで指定した屋根の中の、天窓を設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
skylightID Index of skylight element. ドーマーの番号
edgeIndex Index of roof edge associated with skylight. 縁の番号
cornerOffsetDistance Offset of skylight from corner. 縁の隅からの距離
perpOffsetDistance Offset of skylight from roof edge. 垂線の高さ
symName Name of skylight symbol. シンボルの番号

Example:

skylightID:=CreateSkylight(roofHandle);
SetSkylight(roofHandle,skylightID,6,13'8",2'1",Name2Index('dh2436'));

See Also:

Name2Index  



  SetTrapeziumAttributes Objects - Roofs 
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetTrapeziumAttributes
(   roofObject :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDpthDistance :REAL (Coordinate);
    bottomWidthDistance :REAL (Coordinate);
    useTopWidth :BOOLEAN;
    topWidthDistance :REAL (Coordinate);
    leftAngle :REAL;
    rightAngle :REAL;
    topAngle :REAL
) ;

Python:

def  vs.SetTrapeziumAttributes(roofObject, dormerID, useHeight, heightDpthDistance, bottomWidthDistance, useTopWidth, topWidthDistance, leftAngle, rightAngle, topAngle):
   return None

Description:

Procedure SetTrapeziumAttributes sets the attributes of a trapezium dormer in the referenced roof.

説明

ハンドルで指定した屋根の中の、台形のドーマーを設定します。

Parameters:

roofObject Handle to roof. 屋根のハンドル
dormerID Index of dormer element. ドーマーの番号
useHeight Use height setting to create dormer element. 高さ設定の有無
heightDpthDistance Height/depth distance. 高さまたは厚み
bottomWidthDistance Bottom width. 下部の幅
useTopWidth Use top width to create dormer element. 上部の幅の有無
topWidthDistance Top width. 上部の幅
leftAngle Left roof slope. 左側の傾斜角度
rightAngle Right roof slope. 右側の傾斜角度
topAngle Top roof slope. 上側の傾斜角度

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle, -77'10",21'4.81922",#45°0'0",2'0",10'0");
trapID:=CreateTrapeziumDormer(roofHandle);
SetTrapeziumAttributes(roofHandle,trapID,TRUE,6'0",10'0",TRUE,6'0",#0°0'0",#0°0'0",#8°0'0");
SetDormerAttributes(roofHandle,trapID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");