PointBatch Class Reference

One object for a cloud of screen-space arrows. More...

Inheritance diagram for PointBatch:

Public Member Functions
bool	setPoints (List< PointSprite > points, int? sublocationId)
	Replaces every arrow. sublocationId null draws on the outdoor map.
int	hitTest (math.Point< double > point, double radius)
	Index of the nearest arrow inside radius pixels, or null.
bool	isValid ()
int	getId ()
	Gets the unique identifier of the map object.
MapObjectType	getType ()
	Gets the type of the map object.
Uint8List	getData ()
	Gets the user-defined data associated with the map object.
bool	setVisible (bool visible)
	Method is used to specify the visibility of the map object.
bool	setInteractive (bool interactive)
	Method is used to specify whether the map object can be interacted with.
void	setData (Uint8List data)
	Method is used to set user-defined data for the map object.
bool	setTitle (String title)
	Method is used to set the title of the map object.
bool	setTitleWithStyle (String title, TitleStyle style)
	Method is used to set the title and its style for the map object.
bool	setAlpha (double alpha)
	Method is used to set the opacity of the map object.

Detailed Description

One object for a cloud of screen-space arrows.

setPoints replaces the whole set. The list order is the index returned by hitTest. The host draws the tooltip. Points are not clustered.

Definition at line 35 of file point_batch.dart.

Member Function Documentation

getData()

Uint8List MapObject.getData ( )

inherited

Gets the user-defined data associated with the map object.

Returns

The data stored in the map object.

Dart code snippet:

      // Get custom data
      Map<String, dynamic> retrievedData = _circleMapObject!.data;
      print("Circle custom data: $retrievedData");

getId()

int MapObject.getId ( )

inherited

Gets the unique identifier of the map object.

Returns

The unique identifier of the map object.

Dart code snippet:

      // Get object ID
      int objectId = _circleMapObject!.id;
      print("Circle object ID: $objectId");

getType()

MapObjectType MapObject.getType ( )

inherited

Gets the type of the map object.

Returns

The type of the map object MapObjectType.

Dart code snippet:

      // Get object type
      String objectTypeString = _circleMapObject!.type;
      print("Circle object type: $objectTypeString");

hitTest()

int PointBatch.hitTest	(	math.Point< double >	point,
		double	radius )

Index of the nearest arrow inside radius pixels, or null.

isValid()

bool PointBatch.isValid

(

)

Reimplemented from MapObject.

setAlpha()

bool MapObject.setAlpha ( double alpha )

inherited

Method is used to set the opacity of the map object.

Parameters

alpha

Opacity multiplier. Values below 0 will be set to 0. Values above 1 will be set to 1. Default: 1.

Returns

true if the operation is successful, false otherwise.

Dart code snippet:

      // Set alpha transparency
      bool alphaSuccess = _circleMapObject!.setAlpha(0.7);
      print("Set circle alpha to 0.7: $alphaSuccess");

setData()

void MapObject.setData ( Uint8List data )

inherited

Method is used to set user-defined data for the map object.

Parameters

data	Data to store in the map object.

Dart code snippet:

      // Set custom data
      Map<String, dynamic> customData = {"key": "value", "number": 42};
      bool dataSuccess = _circleMapObject!.setData(customData);
      print("Set circle custom data: $dataSuccess");

setInteractive()

bool MapObject.setInteractive ( bool interactive )

inherited

Method is used to specify whether the map object can be interacted with.

Parameters

interactive

Specifies whether the object can be picked in the pickMapObjectAt method (true) or not (false). Default: false.

Returns

true if the operation is successful, false otherwise.

Dart code snippet:

      // Set interactive mode
      bool interactiveSuccess = _circleMapObject!.setInteractive(true);
      print("Set circle interactive to true: $interactiveSuccess");

setPoints()

bool PointBatch.setPoints	(	List< PointSprite >	points,
		int?	sublocationId )

Replaces every arrow. sublocationId null draws on the outdoor map.

Returns

false when the object has been removed.

setTitle()

bool MapObject.setTitle ( String title )

inherited

Method is used to set the title of the map object.

Parameters

title

The title to display on the location view.

Returns

true if the operation is successful, false otherwise.

Dart code snippet:

      // Set title
      bool titleSuccess = _circleMapObject!.setTitle("Circle Object");
      print("Set circle title to 'Circle Object': $titleSuccess");

setTitleWithStyle()

bool MapObject.setTitleWithStyle ( String title, TitleStyle style )

inherited

Method is used to set the title and its style for the map object.

Parameters

title	The title to display on the location view.
style	Title style parameters TitleStyle.

Returns

true if the operation is successful, false otherwise.

Dart code snippet:

      // Set title with style
      bool titleStyleSuccess =
          _circleMapObject!.setTitleWithStyle("Styled Circle", titleStyle);
      print("Set circle title with style: $titleStyleSuccess");

setVisible()

bool MapObject.setVisible ( bool visible )

inherited

Method is used to specify the visibility of the map object.

Parameters

visible

Specifies whether the object is visible (true) or hidden (false). Default: true.

Returns

true if the operation is successful, false otherwise.

Dart code snippet:

      // Set visibility
      bool visibleSuccess = _circleMapObject!.setVisible(true);
      print("Set circle visibility to true: $visibleSuccess");

---

The documentation for this class was generated from the following file:

• point_batch.dart