IRoofSlopes Interface Reference

Represents roof slopes. More...

Public Member Functions
HRESULT	GetOverhang ([in] int slopeIndex, [out, retval] double *pOverhang)
	Returns the overhang by index of a slope.
HRESULT	GetRoofEdgeShape ([in] int slopeIndex, [out, retval] enum RoofEdgeShape *pRoofEdgeShape)
	Returns the roof edge shape by index of a slope.
HRESULT	GetSlopeAngle ([in] int slopeIndex, [out, retval] double *pSlopeAngle)
	Returns the variant value for slope angle by index of a slope.
HRESULT	GetSlopeLevel ([in] int slopeIndex, [out, retval] double *pSlopeLevel)
	Returns the variant value for slope level by index of a slope.
HRESULT	SetOverhang ([in] int slopeIndex, [in] double overhang)
	Set the overhang value by index of a slope.
HRESULT	SetRoofEdgeShape ([in] int slopeIndex, [in] enum RoofEdgeShape roofEdgeShape)
	Set the roof edge shape by index of a slope.
HRESULT	SetSlopeAngle ([in] int slopeIndex, [in] double slopeAngle)
	Set the slope angle by index of a slope.
HRESULT	SetSlopeLevel ([in] int slopeIndex, [in] double slopeLevel)
	Set the slope level value by index of a slope.

Properties
int	Count [get]
	The number of slopes.

Detailed Description

Represents roof slopes.

This interface can be obtained from IModelObject.

Member Function Documentation

GetOverhang()

HRESULT GetOverhang	(	[in] int	slopeIndex,
		[out, retval] double *	pOverhang )

Returns the overhang by index of a slope.

Parameters

[in]	slopeIndex	Index of a slope.
[out]	pOverhang	Angle in millimeters.

GetSlopeAngle()

HRESULT GetSlopeAngle	(	[in] int	slopeIndex,
		[out, retval] double *	pSlopeAngle )

Returns the variant value for slope angle by index of a slope.

Note

For slope with shape RoofEdgeShape::RoofEdgeShape_Gable returned value is invalid.

Parameters

[in]	slopeIndex	Index of a slope.
[out]	pSlopeAngle	Angle in degrees.

GetSlopeLevel()

HRESULT GetSlopeLevel	(	[in] int	slopeIndex,
		[out, retval] double *	pSlopeLevel )

Returns the variant value for slope level by index of a slope.

Note

For slope with shape RoofEdgeShape::RoofEdgeShape_Gable returned value is invalid.

Parameters

[in]	slopeIndex	Index of a slope.
[out]	pSlopeLevel	Value in millimeters.

SetOverhang()

HRESULT SetOverhang	(	[in] int	slopeIndex,
		[in] double	overhang )

Set the overhang value by index of a slope.

Parameters

[in]	slopeIndex	Index of a slope.
[in]	overhang	Value in millimeters.

SetSlopeAngle()

HRESULT SetSlopeAngle	(	[in] int	slopeIndex,
		[in] double	slopeAngle )

Set the slope angle by index of a slope.

Note

For slope with shape RoofEdgeShape::RoofEdgeShape_Gable this method will do nothing.

Parameters

[in]	slopeIndex	Index of a slope.
[in]	slopeAngle	Angle in degrees.

SetSlopeLevel()

HRESULT SetSlopeLevel	(	[in] int	slopeIndex,
		[in] double	slopeLevel )

Set the slope level value by index of a slope.

Note

For slope with shape RoofEdgeShape::RoofEdgeShape_Gable this method will do nothing.

Parameters

[in]	slopeIndex	Index of a slope.
[in]	slopeLevel	Value in millimeters.