Represents a room object. A room represents a volume bounded actually or theoretically. More...

Public Member Functions
HRESULT	CalculateRegion ([in] Point2D roomPoint, [out, retval] IRoomRegionDescription **ppRoomRegionDescription)
	Calculates the region of the room around the given point and returns the result of the calculation as a IRoomRegionDescription. Returns null, if the given point is located outside the room or on its boundaries.

Properties
VARIANT_BOOL	Automatic `[get]`
	Indicates whether the room is automatically constructed by point.

Point2D	ControlPoint `[get, set]`
	The point of automatically constructed room in the global coordinate system.

Point2D	MarkerPosition `[get, set]`
	The room marker position in the global coordinate system.

BSTR	RoomName `[get]`
	The room name.

BSTR	RoomNumber `[get]`
	The room number.

Detailed Description

Represents a room object. A room represents a volume bounded actually or theoretically.

This interface can be obtained as an additional interface from IModelObject with Room type.

Member Function Documentation

◆ CalculateRegion()

HRESULT CalculateRegion	(	[in] Point2D	roomPoint,
		[out, retval] IRoomRegionDescription **	ppRoomRegionDescription )

Calculates the region of the room around the given point and returns the result of the calculation as a IRoomRegionDescription. Returns null, if the given point is located outside the room or on its boundaries.

Parameters

[in]	roomPoint	The point in the global coordinate system inside the room around which the region will be calculated. For automatic room, this point can be obtained using ControlPoint, and for non-automatic room, for example, by analyzing its baseline.
[out]	ppRoomRegionDescription	The description of the calculated room region.

See also: Automatic, ControlPoint, IRegion2D, IRoomRegionDescription

Property Documentation

◆ Automatic

VARIANT_BOOL Automatic

get

Indicates whether the room is automatically constructed by point.

Returns: TRUE if the room is automatically constructed by point, FALSE otherwise.

◆ ControlPoint

Point2D ControlPoint

getset

The point of automatically constructed room in the global coordinate system.

Returns: The requested point if the room is automatically constructed by point, (0, 0) point otherwise.

See also: Automatic

Note: This property can only be set when the room is Automatic.

◆ RoomName

BSTR RoomName

get

The room name.

See also: Renga::Parameters::RoomName

◆ RoomNumber

BSTR RoomNumber

get

The room number.

See also: Renga::Parameters::RoomNumber

Public Member Functions

Properties