BuildingHighlightOptions (Class)
Namespace: Wrld.Resources.Buildings
Creation parameters for constructing a BuildingHighlight object.
Methods
BuildingHighlightOptions HighlightBuildingAtLocation (LatLong location)
Used to highlight any building that may be present at a LatLong location
Returns: This BuildingHighlightOptions instance, with the query location set.
| Argument | Type | Description |
|---|---|---|
| location | LatLong | The LatLong location to query. |
BuildingHighlightOptions HighlightBuildingAtScreenPoint (Vector2 screenPoint)
Used to highlight any building that may be present at a screen coordinate for the current view point. A ray from the camera origin and passing through the screen point is constructed - the first building that the ray intersects, if any, will be highlighted.
Returns: This BuildingHighlightOptions instance, with the query location set.
| Argument | Type | Description |
|---|---|---|
| screenPoint | Vector2 | The LatLong location to query. |
BuildingHighlightOptions Color (Color color)
Sets the color of the graphical highlight.
Returns: This BuildingHighlightOptions instance, with the color set.
| Argument | Type | Description |
|---|---|---|
| color | Color | The color of the graphical highlight. |
BuildingHighlightOptions HeightRanges (ICollection<BuildingHighlightHeightRange> heightRanges)
Sets the height range(s) of the graphical highlight
Returns: This BuildingHighlightOptions instance, with the height ranges set
| Argument | Type | Description |
|---|---|---|
| heightRanges | ICollection<BuildingHighlightHeightRange> | The height ranges |
BuildingHighlightOptions InformationOnly ()
This BuildingHighlightOptions instance, with the InformationOnly property set to true.
BuildingHighlightOptions BuildingInformationReceivedHandler (BuildingInformationReceivedDelegate handler)
| Argument | Type | Description |
|---|---|---|
| handler | BuildingInformationReceivedDelegate |