Maps API for JavaScript Developer's Guide

H.map.provider.Invalidations

Class Summary

This class represents invalidation states of a renderable object. A renderer can optimize its rendering strategies based on the information in this object.

[ For full details, see the Class Details ]

Property Summary

Table 1. Properties
Properties

static MARK_INITIAL : {H.map.provider.Invalidations.Mark}

This constant represents the initial invalidation mark for an invalidations object.

Method Summary

Table 2. Methods
Methods

update (mark, types)

This method updates invalidation marks according to the caller-provided invalidation types.

getMark () : {H.map.provider.Invalidations.Mark}

This method retrieves the current invalidation mark of the given invalidations object.

isAny (since) : {boolean}

This method checks whether any change occurred after the specified since mark.

isVisual (since) : {boolean}

This method checks whether a visual change occurred after the specified since mark.

isSpatial (since) : {boolean}

This method checks whether a spatial change occurred after the specified since mark.

isAdd (since) : {boolean}

This method checks whether an add-operation occurred after the specified since mark.

isRemove (since) : {boolean}

This method checks whether a remove operation occurred after the specified since mark.

isZOrder (since) : {boolean}

This method checks whether a z-order change occurred after the specified since mark.

Class Description

This class represents invalidation states of a renderable object. A renderer can optimize its rendering strategies based on the information in this object.

For example, renderers may differentiate between a purely visual change to an object and a spatial change. One may only require the change of a color during rendering, the other requires re-projection of the object.

Constructor Details

H.map.provider.Invalidations()

Property Details

static MARK_INITIAL: {H.map.provider.Invalidations.Mark}

This constant represents the initial invalidation mark for an invalidations object.

Method Details

update (mark, types)

This method updates invalidation marks according to the caller-provided invalidation types.

Parameters:
 
mark:
{H.map.provider.Invalidations.Mark}
 
The invalidation mark to set
types:
{H.math.BitMask}
 
The discrete invalidation types to update

getMark () : {H.map.provider.Invalidations.Mark}

This method retrieves the current invalidation mark of the given invalidations object.

Returns:
 
{H.map.provider.Invalidations.Mark}
The current invalidation mark

isAny (since) : {boolean}

This method checks whether any change occurred after the specified since mark.

Parameters:
 
since:
{H.map.provider.Invalidations.Mark}
 
The invalidation mark to check against
Returns:
 
{boolean}
A value indicating whether a change occurred (true), or not (false)

isVisual (since) : {boolean}

This method checks whether a visual change occurred after the specified since mark.

Parameters:
 
since:
{H.map.provider.Invalidations.Mark}
 
The invalidation mark to check against
Returns:
 
{boolean}
A value indicating whether a visual change occurred (true), or not (false)

isSpatial (since) : {boolean}

This method checks whether a spatial change occurred after the specified since mark.

Parameters:
 
since:
{H.map.provider.Invalidations.Mark}
 
The invalidation mark to check against
Returns:
 
{boolean}
A value indicating whether a spatial change occurred (true), or not (false)

isAdd (since) : {boolean}

This method checks whether an add-operation occurred after the specified since mark.

Parameters:
 
since:
{H.map.provider.Invalidations.Mark}
 
The invalidation mark to check against
Returns:
 
{boolean}
A value indicating whether an add operation occurred (true), or not (false)

isRemove (since) : {boolean}

This method checks whether a remove operation occurred after the specified since mark.

Parameters:
 
since:
{H.map.provider.Invalidations.Mark}
 
The invalidation mark to check against
Returns:
 
{boolean}
A value indicating whether a remove operation occurred (true), or not (false)

isZOrder (since) : {boolean}

This method checks whether a z-order change occurred after the specified since mark.

Parameters:
 
since:
{H.map.provider.Invalidations.Mark}
 
The invalidation mark to check against
Returns:
 
{boolean}
A value indicating whether a z-order change operation occurred (true), or not (false)