Roof Controller

interface ICwAPI3DRoofController

Public Functions

virtual double getProfileLength(elementID aElementId) = 0

Gets the profile length.

Parameters:

aElementId[in] [elementID] The element id.

Returns:

[double] The profile length.

virtual double getEdgeLength(elementID aElementId, const character *aEdgeType) = 0

Gets the edge length.

Parameters:
  • aElementId[in] [elementID] The element id.

  • aEdgeType[in] [const character*] The edge type :

    • ”none”

    • ”ridge”

    • ”eave”

    • ”vergeright”

    • ”vergeleft”

    • ”vergeoblique”

    • ”hip”

    • ”valley”

    • ”userdefined1”

    • ”userdefined2”

    • ”userdefinedmitrejoint1”

    • ”userdefinedmitrejoint2”

    • ”wallconnection”

    • ”wallconnectionright”

    • ”wallconnectionleft”

    • ”wallconnectiontop”

    • ”wallconnectionbottom”

    • ”roofcutout”

    • ”roofcutoutright”

    • ”roofcutoutleft”

    • ”roofcutouttop”

    • ”roofcutoutbottom”

    • ”roofedgeontoproofsurface”

    • ”roofedgeonbottomroofsurface”

Returns:

[double] The edge length.

virtual ICwAPI3DElementIDList *getAllCaddyElementIDs() = 0

Gets all caddy elements.

Returns:

[ICwAPI3DElementIDList*] The list of all caddy element Id.

virtual ICwAPI3DString *getLastError(int32_t *aErrorCode) = 0

Gets the last error.

Parameters:

aErrorCode[out] [int32_t*] The error code.

Returns:

[ICwAPI3DString*] The error string.

virtual void clearErrors() = 0

Clears all errors.