org.jactr.modules.pm.visual.visicon.map
Class AbstractVisualMap

java.lang.Object
  org.jactr.modules.pm.visual.visicon.map.AbstractVisualMap

All Implemented Interfaces:

IVisualMap

Direct Known Subclasses:

DefaultVisualMap6

public abstract class AbstractVisualMap
extends java.lang.Object
implements IVisualMap

Constructor Summary

AbstractVisualMap(IVisicon visicon)

Method Summary

void	addFeatureMap(IVisualFeatureMap featureMap)
void	addFilter(IVisualLocationFilter filter)
void	dispose()
java.util.Collection<IVisualFeatureMap>	getFeatureMaps() return an immutable copy of the available feature maps
IFINSTFeatureMap	getFINSTFeatureMap()
double[]	getLocation(IChunk visualLocationChunk) return the x,y location of the visuallocation chunk.
IVisibilityFeatureMap	getVisibilityFeatureMap()
IVisicon	getVisicon()
int	getVisualFieldHeight()
int	getVisualFieldHorizontalResolution()
int	getVisualFieldVerticalResolution()
int	getVisualFieldWidth()
IChunk	getVisualLocationChunk(double x, double y) internal version -
java.util.Collection<IVisualLocationFilter>	getVisualLocationFilters() the set of possible filters used in pruning and prioritizing visual location searches
IChunk	getVisualLocationFor(ChunkTypeRequest request) return the visual location that matches the x and y stored in this chunk pattern
IChunk	getVisualLocationFor(org.commonreality.identifier.IIdentifier identifier) return the visual location of the afferent object, or null if the object is not visible
void	removeFeatureMap(IVisualFeatureMap featureMap)
void	removeFilter(IVisualLocationFilter filter)
void	setVisualFieldHeight(int height)
void	setVisualFieldHorizontalResolution(int horizontalResolution)
void	setVisualFieldVerticalResolution(int verticalResolution)
void	setVisualFieldWidth(int width)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractVisualMap

public AbstractVisualMap(IVisicon visicon)

Method Detail

dispose

public void dispose()

Specified by:

dispose in interface IVisualMap

getVisicon

public IVisicon getVisicon()

Specified by:

getVisicon in interface IVisualMap

addFilter

public void addFilter(IVisualLocationFilter filter)

Specified by:

addFilter in interface IVisualMap

removeFilter

public void removeFilter(IVisualLocationFilter filter)

Specified by:

removeFilter in interface IVisualMap

addFeatureMap

public void addFeatureMap(IVisualFeatureMap featureMap)

Specified by:

addFeatureMap in interface IVisualMap

removeFeatureMap

public void removeFeatureMap(IVisualFeatureMap featureMap)

Specified by:

removeFeatureMap in interface IVisualMap

getVisibilityFeatureMap

public IVisibilityFeatureMap getVisibilityFeatureMap()

Specified by:

getVisibilityFeatureMap in interface IVisualMap

getFINSTFeatureMap

public IFINSTFeatureMap getFINSTFeatureMap()

Specified by:

getFINSTFeatureMap in interface IVisualMap

getFeatureMaps

public java.util.Collection<IVisualFeatureMap> getFeatureMaps()

Description copied from interface: IVisualMap

return an immutable copy of the available feature maps

Specified by:

getFeatureMaps in interface IVisualMap

Returns:

getVisualLocationFilters

public java.util.Collection<IVisualLocationFilter> getVisualLocationFilters()

Description copied from interface: IVisualMap

the set of possible filters used in pruning and prioritizing visual location searches

Specified by:

getVisualLocationFilters in interface IVisualMap

Returns:

getLocation

public double[] getLocation(IChunk visualLocationChunk)

Description copied from interface: IVisualMap

return the x,y location of the visuallocation chunk.

Specified by:

getLocation in interface IVisualMap

Returns:

getVisualLocationChunk

public IChunk getVisualLocationChunk(double x,
                                     double y)

internal version -

Specified by:

getVisualLocationChunk in interface IVisualMap

Parameters:

x -

y -

Returns:

getVisualFieldHeight

public int getVisualFieldHeight()

Specified by:

getVisualFieldHeight in interface IVisualMap

setVisualFieldHeight

public void setVisualFieldHeight(int height)

Specified by:

setVisualFieldHeight in interface IVisualMap

getVisualFieldHorizontalResolution

public int getVisualFieldHorizontalResolution()

Specified by:

getVisualFieldHorizontalResolution in interface IVisualMap

setVisualFieldHorizontalResolution

public void setVisualFieldHorizontalResolution(int horizontalResolution)

Specified by:

setVisualFieldHorizontalResolution in interface IVisualMap

getVisualFieldVerticalResolution

public int getVisualFieldVerticalResolution()

Specified by:

getVisualFieldVerticalResolution in interface IVisualMap

setVisualFieldVerticalResolution

public void setVisualFieldVerticalResolution(int verticalResolution)

Specified by:

setVisualFieldVerticalResolution in interface IVisualMap

getVisualFieldWidth

public int getVisualFieldWidth()

Specified by:

getVisualFieldWidth in interface IVisualMap

setVisualFieldWidth

public void setVisualFieldWidth(int width)

Specified by:

setVisualFieldWidth in interface IVisualMap

getVisualLocationFor

public IChunk getVisualLocationFor(org.commonreality.identifier.IIdentifier identifier)
                            throws IllegalModuleStateException

Description copied from interface: IVisualMap

return the visual location of the afferent object, or null if the object is not visible

Specified by:

getVisualLocationFor in interface IVisualMap

Returns:

Throws:

IllegalModuleStateException - if there is no information for the identifier or the system is not connected to common reality

getVisualLocationFor

public IChunk getVisualLocationFor(ChunkTypeRequest request)

return the visual location that matches the x and y stored in this chunk pattern

Specified by:

getVisualLocationFor in interface IVisualMap

Parameters:

request -

Returns:

the correct visual location or null