r3roof

r3roof

Class

plugins/objects/wall/r3roof.h

Library

r3wall

Description:

roof extrusion object

See Also

plugins/objects/wall/r3buildbase.h

Super Class

r3Level

R3CLID_LEVEL

JavaScript

r3Roof

Class Identifier

R3CLID_ROOF - 2596

Methods

ROOFMATERIALNAME, BASE2MATERIALNAME,

Attributes

Height, Offset, EndType, AutoTexture, Base1, Base1EdgeType, Base1FillType, Base1TopFill, Base1Thickness, Base1Offset, Base2, Base2EdgeType, Base2FillType, Base2TopFill, Base2Thickness, Base2Offset, Measures, MeasureOffset, MeasureTextSize, MeasureArrowSize, EaveElevation, IgnoreChildChanges,

Attributes

R3ROOFM_ROOFMATERIALNAME

Method

ROOFMATERIALNAME

Identifier

R3ROOFM_ROOFMATERIALNAME

Param 3:

char*, name buffer of STRLEN_DOSNAME chars

JavaScript

obj.ROOFMATERIALNAME(p3);

Description

generate the material name for automatic roof texturing

R3ROOFM_BASE2MATERIALNAME

Method

BASE2MATERIALNAME

Identifier

R3ROOFM_BASE2MATERIALNAME

Param 3:

char*, name buffer of STRLEN_DOSNAME chars

JavaScript

obj.BASE2MATERIALNAME(p3);

Description

generate the material name for automatic roof base texturing

Height

Attribute

Height

Identifier

R3ROOFA_Height

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetHeight(value);
value = jsobj.GetHeight();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Height, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_Height, &value, R3TAG_END);

Offset

Attribute

Offset

Identifier

R3ROOFA_Offset

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetOffset(value);
value = jsobj.GetOffset();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Offset, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_Offset, &value, R3TAG_END);

EndType

Attribute

EndType

Identifier

R3ROOFA_EndType

JavaScript type

Integer

C type

R3INT

Description

Syntax


jsobj.SetEndType(value);
value = jsobj.GetEndType();


R3INT value = ...;
R3SetAttrs(r3obj, R3ROOFA_EndType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3ROOFA_EndType, &value, R3TAG_END);

AutoTexture

Attribute

AutoTexture

Identifier

R3ROOFA_AutoTexture

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetAutoTexture(value);
value = jsobj.GetAutoTexture();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3ROOFA_AutoTexture, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3ROOFA_AutoTexture, &value, R3TAG_END);

Base1

Attribute

Base1

Identifier

R3ROOFA_Base1

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetBase1(value);
value = jsobj.GetBase1();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base1, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3ROOFA_Base1, &value, R3TAG_END);

Base1EdgeType

Attribute

Base1EdgeType

Identifier

R3ROOFA_Base1EdgeType

JavaScript type

Integer

C type

R3INT

Description

Syntax


jsobj.SetBase1EdgeType(value);
value = jsobj.GetBase1EdgeType();


R3INT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base1EdgeType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3ROOFA_Base1EdgeType, &value, R3TAG_END);

Base1FillType

Attribute

Base1FillType

Identifier

R3ROOFA_Base1FillType

JavaScript type

Integer

C type

R3INT

Description

Syntax


jsobj.SetBase1FillType(value);
value = jsobj.GetBase1FillType();


R3INT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base1FillType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3ROOFA_Base1FillType, &value, R3TAG_END);

Base1TopFill

Attribute

Base1TopFill

Identifier

R3ROOFA_Base1TopFill

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetBase1TopFill(value);
value = jsobj.GetBase1TopFill();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base1TopFill, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3ROOFA_Base1TopFill, &value, R3TAG_END);

Base1Thickness

Attribute

Base1Thickness

Identifier

R3ROOFA_Base1Thickness

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetBase1Thickness(value);
value = jsobj.GetBase1Thickness();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base1Thickness, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_Base1Thickness, &value, R3TAG_END);

Base1Offset

Attribute

Base1Offset

Identifier

R3ROOFA_Base1Offset

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetBase1Offset(value);
value = jsobj.GetBase1Offset();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base1Offset, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_Base1Offset, &value, R3TAG_END);

Base2

Attribute

Base2

Identifier

R3ROOFA_Base2

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetBase2(value);
value = jsobj.GetBase2();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base2, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3ROOFA_Base2, &value, R3TAG_END);

Base2EdgeType

Attribute

Base2EdgeType

Identifier

R3ROOFA_Base2EdgeType

JavaScript type

Integer

C type

R3INT

Description

Syntax


jsobj.SetBase2EdgeType(value);
value = jsobj.GetBase2EdgeType();


R3INT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base2EdgeType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3ROOFA_Base2EdgeType, &value, R3TAG_END);

Base2FillType

Attribute

Base2FillType

Identifier

R3ROOFA_Base2FillType

JavaScript type

Integer

C type

R3INT

Description

Syntax


jsobj.SetBase2FillType(value);
value = jsobj.GetBase2FillType();


R3INT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base2FillType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3ROOFA_Base2FillType, &value, R3TAG_END);

Base2TopFill

Attribute

Base2TopFill

Identifier

R3ROOFA_Base2TopFill

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetBase2TopFill(value);
value = jsobj.GetBase2TopFill();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base2TopFill, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3ROOFA_Base2TopFill, &value, R3TAG_END);

Base2Thickness

Attribute

Base2Thickness

Identifier

R3ROOFA_Base2Thickness

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetBase2Thickness(value);
value = jsobj.GetBase2Thickness();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base2Thickness, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_Base2Thickness, &value, R3TAG_END);

Base2Offset

Attribute

Base2Offset

Identifier

R3ROOFA_Base2Offset

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetBase2Offset(value);
value = jsobj.GetBase2Offset();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_Base2Offset, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_Base2Offset, &value, R3TAG_END);

Measures

Attribute

Measures

Identifier

R3ROOFA_Measures

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetMeasures(value);
value = jsobj.GetMeasures();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3ROOFA_Measures, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3ROOFA_Measures, &value, R3TAG_END);

MeasureOffset

Attribute

MeasureOffset

Identifier

R3ROOFA_MeasureOffset

JavaScript type

Number

C type

R3FLOAT

Description

distance

Syntax


jsobj.SetMeasureOffset(value);
value = jsobj.GetMeasureOffset();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_MeasureOffset, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_MeasureOffset, &value, R3TAG_END);

MeasureTextSize

Attribute

MeasureTextSize

Identifier

R3ROOFA_MeasureTextSize

JavaScript type

Number

C type

R3FLOAT

Description

pixels

Syntax


jsobj.SetMeasureTextSize(value);
value = jsobj.GetMeasureTextSize();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_MeasureTextSize, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_MeasureTextSize, &value, R3TAG_END);

MeasureArrowSize

Attribute

MeasureArrowSize

Identifier

R3ROOFA_MeasureArrowSize

JavaScript type

Number

C type

R3FLOAT

Description

pixels

Syntax


jsobj.SetMeasureArrowSize(value);
value = jsobj.GetMeasureArrowSize();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_MeasureArrowSize, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_MeasureArrowSize, &value, R3TAG_END);

EaveElevation

Attribute

EaveElevation

Identifier

R3ROOFA_EaveElevation

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetEaveElevation(value);
value = jsobj.GetEaveElevation();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3ROOFA_EaveElevation, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3ROOFA_EaveElevation, &value, R3TAG_END);

IgnoreChildChanges

Attribute

IgnoreChildChanges

Identifier

R3ROOFA_IgnoreChildChanges

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetIgnoreChildChanges(value);
value = jsobj.GetIgnoreChildChanges();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3ROOFA_IgnoreChildChanges, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3ROOFA_IgnoreChildChanges, &value, R3TAG_END);

Roof specific component type codes for R3BBASA_TargetID

Roof end types

R3ROOFEND_STRAIGHT
R3ROOFEND_MATCHROOFLINE
R3ROOFEND_BEVEL

Edge types of roof base layers

R3ROOFBASEEDGE_HORIZONTAL
R3ROOFBASEEDGE_VERTICAL
R3ROOFBASEEDGE_PERPENDICULAR

Fill types of roof base layers

R3ROOFBASEFILL_PARALLEL
R3ROOFBASEFILL_HORIZONTAL