Files
win8phoneApp/Doc/man/man3/CampusAppWP8_Model_Campusmap_MapModel.3
stubbfel 38e75365ef add doku
2013-10-11 14:42:47 +02:00

434 lines
11 KiB
Groff

.TH "CampusAppWP8.Model.Campusmap.MapModel" 3 "Fri Oct 11 2013" "CampusAppWp8" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CampusAppWP8.Model.Campusmap.MapModel \-
.PP
This Class manage the properties of a Map
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBCampusAppWP8\&.Model\&.Campusmap\&.BuildingMapModel\fP, and \fBCampusAppWP8\&.Model\&.Campusmap\&.CampusMapModel\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBMapModel\fP ()"
.br
.RI "\fIInitializes a new instance of the \fBMapModel\fP class\&. \fP"
.ti -1c
.RI "\fBMapModel\fP (List< \fBPlaceModel\fP > placeList)"
.br
.RI "\fIInitializes a new instance of the \fBMapModel\fP class\&. \fP"
.ti -1c
.RI "delegate void \fBMapInfos\fP (List< \fBPlaceModel\fP > places)"
.br
.RI "\fIDelegate for MapInfo \fP"
.ti -1c
.RI "Point \fBGetScrollPoint\fP (Point point)"
.br
.RI "\fIMethod calculate the coordinates of ScrollToOffsets point \fP"
.ti -1c
.RI "Point \fBGetScrollPoint\fP (double x, double y)"
.br
.RI "\fIMethod calculate the coordinates of ScrollToOffsets point \fP"
.ti -1c
.RI "Image \fBAddPin\fP (double x, double y, \fBMapPinModel\&.PinType\fP type, List< \fBPlaceModel\fP > places=null)"
.br
.RI "\fIMethod create in image, which can show at a certain position\&.\fP"
.ti -1c
.RI "Image \fBAddPinFromRefPoint\fP (double x, double y, \fBMapPinModel\&.PinType\fP type, List< \fBPlaceModel\fP > places=null)"
.br
.RI "\fIMethod create in image, which can show at a certain position depend of the \fBRefPoint\fP \fP"
.ti -1c
.RI "Image \fBAddPinFromRefPoint\fP (Point position, \fBMapPinModel\&.PinType\fP type, List< \fBPlaceModel\fP > places=null)"
.br
.RI "\fIMethod create in image, which can show at a certain position depend of the \fBRefPoint\fP \fP"
.ti -1c
.RI "Image \fBAddPin\fP (Point position, \fBMapPinModel\&.PinType\fP type, List< \fBPlaceModel\fP > places=null)"
.br
.RI "\fIMethod create in image, which can show at a certain position\&.\fP"
.ti -1c
.RI "Point \fBConverToPixelPoint\fP (double x, double y)"
.br
.RI "\fIConvert a coordinates to coordinates which address pixels\&.\fP"
.ti -1c
.RI "Point \fBConverToPixelPoint\fP (Point point)"
.br
.RI "\fIConvert a coordinates to coordinates which address pixels \fP"
.ti -1c
.RI "Point \fBConverToMapPoint\fP (double x, double y)"
.br
.RI "\fIConvert a coordinates to coordinates which address mapPoint \fP"
.ti -1c
.RI "Point \fBConverToMapPoint\fP (Point point)"
.br
.RI "\fIConvert a coordinates to coordinates which address mapPoint \fP"
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBLoadSpatials\fP (List< \fBPlaceModel\fP > placeList)"
.br
.RI "\fILoads the spatial\&./\fP"
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.RI "bool \fBIsReady\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets a value indicating whether the map is ready or not \fP"
.ti -1c
.RI "string \fBImageSource\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the ImageSource of the map \fP"
.ti -1c
.RI "double \fBImageWidth\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the ImageWidth of the map \fP"
.ti -1c
.RI "double \fBImageHeight\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the ImageHeight of the map \fP"
.ti -1c
.RI "double \fBMapImageOffsetX\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the ImageOffsetX of the map \fP"
.ti -1c
.RI "double \fBMapImageOffsetY\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the ImageOffsetY of the map \fP"
.ti -1c
.RI "double \fBGeoOffsetX\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the GeoOffsetX of the map \fP"
.ti -1c
.RI "double \fBGeoOffsetY\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the GeoOffsetY of the map \fP"
.ti -1c
.RI "double \fBScaleX\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the Scale (to pixel) of the map \fP"
.ti -1c
.RI "double \fBScaleY\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the Scale (to pixel) of the map \fP"
.ti -1c
.RI "Point \fBRefPoint\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the reference point \fP"
.ti -1c
.RI "\fBSpsModel\fP \fBSpatial\fP\fC [get, set]\fP"
.br
.RI "\fIGets or sets the spatial of the map\&.\fP"
.in -1c
.SS "Events"
.in +1c
.ti -1c
.RI "\fBMapInfos\fP \fBShowMapInfos\fP = null"
.br
.RI "\fIEvent ShowMapInfo \fP"
.in -1c
.SH "Detailed Description"
.PP
This Class manage the properties of a Map
.SH "Constructor & Destructor Documentation"
.PP
.SS "CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.MapModel ()"
.PP
Initializes a new instance of the \fBMapModel\fP class\&.
.SS "CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.MapModel (List< \fBPlaceModel\fP >placeList)"
.PP
Initializes a new instance of the \fBMapModel\fP class\&.
.PP
\fBParameters:\fP
.RS 4
\fIplaceList\fP list of places
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "Image CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.AddPin (doublex, doubley, \fBMapPinModel\&.PinType\fPtype, List< \fBPlaceModel\fP >places = \fCnull\fP)"
.PP
Method create in image, which can show at a certain position\&.Stubbfel, 27\&.08\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIx\fP the x- coordinate\&.
.br
\fIy\fP the y-coordinate\&.
.br
\fItype\fP The type\&.
.br
\fIplaces\fP list of places
.RE
.PP
\fBReturns:\fP
.RS 4
image of the pin\&.
.RE
.PP
.SS "Image CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.AddPin (Pointposition, \fBMapPinModel\&.PinType\fPtype, List< \fBPlaceModel\fP >places = \fCnull\fP)"
.PP
Method create in image, which can show at a certain position\&.Stubbfel, 27\&.08\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIposition\fP input point\&.
.br
\fItype\fP The type\&.
.br
\fIplaces\fP list of places
.RE
.PP
\fBReturns:\fP
.RS 4
image of the pin\&.
.RE
.PP
.SS "Image CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.AddPinFromRefPoint (doublex, doubley, \fBMapPinModel\&.PinType\fPtype, List< \fBPlaceModel\fP >places = \fCnull\fP)"
.PP
Method create in image, which can show at a certain position depend of the \fBRefPoint\fP Stubbfel, 27\&.08\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIx\fP the x-coordinate\&.
.br
\fIy\fP the y-coordinate\&.
.br
\fItype\fP The type\&.
.br
\fIplaces\fP list of places
.RE
.PP
\fBReturns:\fP
.RS 4
image of the pin\&.
.RE
.PP
.SS "Image CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.AddPinFromRefPoint (Pointposition, \fBMapPinModel\&.PinType\fPtype, List< \fBPlaceModel\fP >places = \fCnull\fP)"
.PP
Method create in image, which can show at a certain position depend of the \fBRefPoint\fP Stubbfel, 27\&.08\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIposition\fP input point\&.
.br
\fItype\fP The type\&.
.br
\fIplaces\fP list of places
.RE
.PP
\fBReturns:\fP
.RS 4
image of the pin\&.
.RE
.PP
.SS "Point CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ConverToMapPoint (doublex, doubley)"
.PP
Convert a coordinates to coordinates which address mapPoint
.PP
\fBParameters:\fP
.RS 4
\fIx\fP the x-coordinate
.br
\fIy\fP the y-coordinate
.RE
.PP
\fBReturns:\fP
.RS 4
Point in pixel-size
.RE
.PP
.SS "Point CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ConverToMapPoint (Pointpoint)"
.PP
Convert a coordinates to coordinates which address mapPoint
.PP
\fBParameters:\fP
.RS 4
\fIpoint\fP not scaled point
.RE
.PP
\fBReturns:\fP
.RS 4
Point in pixel-size
.RE
.PP
.SS "Point CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ConverToPixelPoint (doublex, doubley)"
.PP
Convert a coordinates to coordinates which address pixels\&.Stubbfel, 27\&.08\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIx\fP the x-coordinate\&.
.br
\fIy\fP the y-coordinate\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Point in pixel-size\&.
.RE
.PP
.SS "Point CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ConverToPixelPoint (Pointpoint)"
.PP
Convert a coordinates to coordinates which address pixels
.PP
\fBParameters:\fP
.RS 4
\fIpoint\fP not scaled point
.RE
.PP
d
.PP
\fBReturns:\fP
.RS 4
Point in pixel-size
.RE
.PP
.SS "Point CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.GetScrollPoint (Pointpoint)"
.PP
Method calculate the coordinates of ScrollToOffsets point
.PP
\fBParameters:\fP
.RS 4
\fIpoint\fP input point
.RE
.PP
\fBReturns:\fP
.RS 4
point (in pixel)
.RE
.PP
.SS "Point CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.GetScrollPoint (doublex, doubley)"
.PP
Method calculate the coordinates of ScrollToOffsets point the input-point will be shown in the center
.PP
\fBParameters:\fP
.RS 4
\fIx\fP x - coordinate
.br
\fIy\fP y - coordinate
.RE
.PP
\fBReturns:\fP
.RS 4
point (in pixel)
.RE
.PP
.SS "virtual void CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.LoadSpatials (List< \fBPlaceModel\fP >placeList)\fC [protected]\fP, \fC [virtual]\fP"
.PP
Loads the spatial\&./Stubbfel, 19\&.08\&.2013\&.
.PP
\fBParameters:\fP
.RS 4
\fIplaceList\fP list of places
.RE
.PP
.PP
Reimplemented in \fBCampusAppWP8\&.Model\&.Campusmap\&.CampusMapModel\fP\&.
.SS "delegate void CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.MapInfos (List< \fBPlaceModel\fP >places)"
.PP
Delegate for MapInfo
.PP
\fBParameters:\fP
.RS 4
\fIplaces\fP list of places
.RE
.PP
.SH "Property Documentation"
.PP
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.GeoOffsetX\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the GeoOffsetX of the map
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.GeoOffsetY\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the GeoOffsetY of the map
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ImageHeight\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the ImageHeight of the map
.SS "string CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ImageSource\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the ImageSource of the map
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ImageWidth\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the ImageWidth of the map
.SS "bool CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.IsReady\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets a value indicating whether the map is ready or not
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.MapImageOffsetX\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the ImageOffsetX of the map
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.MapImageOffsetY\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the ImageOffsetY of the map
.SS "Point CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.RefPoint\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the reference point
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ScaleX\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the Scale (to pixel) of the map
.SS "double CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ScaleY\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the Scale (to pixel) of the map
.SS "\fBSpsModel\fP CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.Spatial\fC [get]\fP, \fC [set]\fP"
.PP
Gets or sets the spatial of the map\&.The spatial\&.
.SH "Event Documentation"
.PP
.SS "\fBMapInfos\fP CampusAppWP8\&.Model\&.Campusmap\&.MapModel\&.ShowMapInfos = null"
.PP
Event ShowMapInfo
.SH "Author"
.PP
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.