Skip to main content
Version: 20 Mar 2024

MLPlaneBoundaries

Module: Planes

Type to represent multiple regions on a 2D plane. More...

#include <ml_planes.h>

Public Attributes

TypeName
MLHandleid
MLPlaneBoundary *boundaries
uint32_tboundaries_count

Detailed Description

struct MLPlaneBoundaries;

Type to represent multiple regions on a 2D plane.

Deprecated

Deprecated since 1.6.0. Scheduled for removal.

API Level:

  • 2

Public Attributes Documentation

id

MLHandle id;
TypeDescription
MLHandleInteger handle type used to reference many things returned by the API, instead of returning pointers directly. Use MLHandleIsValid() to check if a handle is valid or not.

Plane ID, the same value associating to the ID in MLPlane if they belong to the same plane.


boundaries

MLPlaneBoundary * boundaries;
TypeDescription
MLPlaneBoundary *Type used to represent a region boundary on a 2D plane.

The boundaries in a plane.


boundaries_count

uint32_t boundaries_count;

Count of boundaries. A plane may contain multiple boundaries each of which defines a region.