User Tools

Site Tools

Trace: • map_suite_overlays
thinkgeo.mapsuite.core.geotexturebrush

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
thinkgeo.mapsuite.core.geotexturebrush [2015/08/31 05:25]
admin [Inheritance Hierarchy] 		thinkgeo.mapsuite.core.geotexturebrush [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Core.GeoTextureBrush ====== ====== ThinkGeo.MapSuite.Core.GeoTextureBrush ======
  
- +{{section>​upgrade_map_suite_to_10.0}}
  
 This class is used to fill an area with a image texture. This class is used to fill an area with a image texture.
-=== Remarks === 
-This class is used to fill an area with a image texture. For example, you may have a small bitmap that looks like marble, which you can then use to fill in an area feature. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
   *System.Object   *System.Object
-    *[[ThinkGeo.MapSuite.Core.GeoBrush]] +    *ThinkGeo.MapSuite.Core.GeoBrush 
-      *[[ThinkGeo.MapSuite.Core.GeoTextureBrush]]+      ***ThinkGeo.MapSuite.Core.GeoTextureBrush**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} GeoTextureBrush(GeoImage) ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#GeoTextureBrush(GeoImage)|GeoTextureBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ​  ​| ​   | This is a constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoTextureBrush(GeoImage,​ DrawingRectangleF)|GeoTextureBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],​ [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] ​  ​| ​   | This is a constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoTextureBrush(GeoImage,​ GeoWrapMode)|GeoTextureBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],​ [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] ​  ​| ​   | This is a constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoTextureBrush(GeoImage,​ GeoWrapMode,​ DrawingRectangleF)|GeoTextureBrush]] ​  | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]],​ [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]],​ [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] ​  ​| ​   | This is a constructor for the class. ​  |+
  
-==== Protected Constructors ​==== +  * //This is a constructor for the class.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //You will use this constructor when you want to use the Tile wrap mode and you want the image fill to encompass the entire shape.// 
 +== Parameters ​== 
 +  * //image// 
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] 
 +    * Description:​This parameter is the image you want to use as the texture.
  
-==== Public Methods ==== +<div newline></​div>​ 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} ​GeoTextureBrush(GeoImage,​DrawingRectangleF) **
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​CloneDeep()|CloneDeep]] ​  ​| ​   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] ​  | Create a copy of GeoBrush using the deep clone process. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Protected Methods ​==== +  * //This is a constructor for the class.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks ​== 
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#​CloneDeepCore()|CloneDeepCore]] ​  ​| ​   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]   | Create a copy of GeoBrush using the deep clone process. The default implementation uses serialization. ​  | +  * //This method allows you to pass in a rectangle in screen coordinates to determine how much of the area is textured.//​ 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +== Parameters ​== 
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   |+  * //image// 
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] 
 +    ​* Description:This parameter is the image you want to use as the texture.
  
-==== Public Properties ==== +  * //​rectangleF//​ 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +    * Type:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-| {{wiki:PublicProperty.gif|Public Property}}[[#​DrawingRectangleF|DrawingRectangleF]] ​  ​| ​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] ​  |    | This property gets and sets the screen rectangle used to fill the texture. ​  | +    ​* Description:This parameter is a rectangle (in screen coordinates) ​that specifies ​the area you want to use for the texture.
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​GeoImage|GeoImage]] ​  | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ​  ​| ​   | This property gets and sets the GeoImage used for the texture fill.   | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​GeoWrapMode|GeoWrapMode]] ​  | [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] ​  ​| ​   | This property gets and sets the wrap mode that is used to determine how an area is filled if the area is larger than the texture. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Id|Id]] ​  | Int64   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] ​  | The id of the GeoBrush. This is always used as a key when in the cached brushes. ​  |+
  
-==== Protected Properties ==== +<div newline></​div>​ 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+** {{wiki:​PublicMethod.gif|}} GeoTextureBrush(GeoImage,​GeoWrapMode) **
  
-==== Public Events ​==== +  * //This is a constructor for the class.// 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //None// 
 +== Parameters ​== 
 +  * //image// 
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] 
 +    * Description:​This parameter is the image you want to use as the texture.
  
-===== Public Constructors ===== +  * //​wrapMode//​ 
-==== GeoTextureBrush(GeoImage) ==== +    ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] 
-This is a constructor for the class. +    * Description:​This parameter ​determines ​the way the texture wraps when the area to fill is larger than the texture.
-=== Overloads === +
-This overload allows you to pass in the image for the texture. +
-=== Remarks === +
-You will use this constructor when you want to use the Tile wrap mode and you want the image fill to encompass the entire shape. +
-=== Parameters === +
-^  Name ^  ​Type ^  Description ^ +
-| image   ​| ​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]   | This parameter ​is the image you want to use as the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +<div newline></​div>​ 
-==== GeoTextureBrush(GeoImage,​ DrawingRectangleF) ​==== +** {{wiki:​PublicMethod.gif|}} GeoTextureBrush(GeoImage,​GeoWrapMode,​DrawingRectangleF) ​**
-This is a constructor for the class. +
-=== Overloads === +
-This constructor allows you to pass in the image as well as a screen rectangle that determines how much of the area is filled. +
-=== Remarks === +
-This method allows you to pass in a rectangle in screen coordinates to determine how much of the area is textured. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^ +
-| image   | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ​  | This parameter is the image you want to use as the texture. ​  | +
-| rectangleF ​  | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] ​  | This parameter is a rectangle (in screen coordinates) that specifies the area you want to use for the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //This is a constructor for the class.// 
-==== GeoTextureBrush(GeoImage,​ GeoWrapMode) ==== +== Remarks ​== 
-This is a constructor for the class. +  * //None// 
-=== Overloads === +== Parameters == 
-This constructor allows you to pass in the image and the wrap mode. +  ​* //image// 
-=== Parameters ​=== +    * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] 
-^  Name ^  ​Type ​^  Description ^ +    * Description:​This parameter is the image you want to use as the texture.
-| image   ​| ​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ​  | This parameter is the image you want to use as the texture. ​  | +
-| wrapMode ​  | [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] ​  | This parameter determines the way the texture wraps when the area to fill is larger than the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //​wrapMode//​ 
-==== GeoTextureBrush(GeoImage,​ GeoWrapMode,​ DrawingRectangleF) ==== +    ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] 
-This is a constructor for the class. +    * Description:​This parameter determines the way the texture wraps when the area to fill is larger than the texture.
-=== Overloads === +
-This constructor allows you to pass in the image as well as a screen rectangle that determines how much of the area is filled along with the wrap mode. +
-=== Parameters === +
-^  Name ^  ​Type ^  Description ^ +
-| image   | [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ​  | This parameter is the image you want to use as the texture. ​  | +
-| wrapMode ​  ​| ​[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] ​ ​| ​This parameter determines the way the texture wraps when the area to fill is larger than the texture. ​  | +
-| rectangleF ​  | [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] ​  | This parameter is a rectangle (in screen coordinates) that specifies the area you want to use for the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //​rectangleF//​ 
-===== Protected Constructors ===== +    * Type:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] 
-===== Public Methods ===== +    * Description:​This parameter is a rectangle (in screen coordinates) that specifies the area you want to use for the texture.
-==== CloneDeep() ==== +
-Create a copy of GeoBrush using the deep clone process. +
-=== Remarks === +
-The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]  | A cloned GeoBrush.   |+
  
-=== Parameters ​=== +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^+==== Protected Constructors ==== 
 +==== Public Methods ​==== 
 +** {{wiki:​PublicMethod.gif|}} CloneDeep() **
  
 +  * //N/A//
 +== Remarks ==
 +  * //N/A//
  
-[[#Public Methods|Go Back]] +== Return Value == 
-==== Equals(Object) ==== +  ​* ​Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] 
-=== Return Value === +  ​* Description:​N/​A
-^ Return ​Type ^ Description ^ +
-| Boolean ​ |    |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  Type ^  Description ^ +<div newline></​div>​ 
-| obj   | Object ​ |    |+** {{wiki:​PublicMethod.gif|}} ToString() **
  
 +  * //N/A//
 +== Remarks ==
 +  * //N/A//
  
-[[#Public Methods|Go Back]] +== Return Value == 
-==== GetHashCode() ==== +  ​* ​Type:String 
-=== Return Value === +  ​* Description:​N/​A
-^ Return ​Type ^ Description ^ +
-| Int32  |    |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
  
 +  * //N/A//
 +== Remarks ==
 +  * //N/A//
  
-[[#Public Methods|Go Back]] +== Return Value == 
-==== GetType() ==== +  ​* ​Type:Boolean 
-=== Return Value === +  ​* Description:​N/​A
-^ Return ​Type ^ Description ^ +
-| Type  |    |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== ToString() ==== +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String ​ |    |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
 +== Return Value ==
 +  * Type:Int32
 +  * Description:​N/​A
  
-[[#Public Methods|Go Back]] +== Parameters ​== 
-===== Protected Methods ===== +<div newline></​div>​ 
-==== CloneDeepCore() ==== +** {{wiki:PublicMethod.gif|}} GetType() **
-Create a copy of GeoBrush using the deep clone process. The default implementation uses serialization. +
-=== Remarks === +
-The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] ​  | A cloned GeoBrush. ​  |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
 +== Return Value ==
 +  * Type:Type
 +  * Description:​N/​A
  
-[[#​Protected Methods|Go Back]] +== Parameters ​== 
-==== Finalize() ​==== +<div newline></​div>​ 
-=== Return Value === +==== Protected Methods ​==== 
-^ Return Type ^ Description ^ +** {{wiki:​ProtectedMethod.gif|}} CloneDeepCore() **
-| Void |    |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
 +== Return Value ==
 +  * Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
 +  * Description:​N/​A
  
-[[#​Protected Methods|Go Back]] +== Parameters ​== 
-==== MemberwiseClone() ​==== +<div newline></​div>​ 
-=== Return Value === +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
-^ Return Type ^ Description ^ +
-| Object ​  ​| ​   |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-[[#​Protected Methods|Go Back]] +== Return Value == 
-===== Public Properties ​===== +  * Type:Void 
-==== DrawingRectangleF ​==== +  * Description:​N/​A 
-This property gets and sets the screen rectangle used to fill the texture. + 
-=== Return Value === +== Parameters ​== 
-^ Return Type ^ +<div newline></​div>​ 
-| [[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]] ​  |+** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() ** 
 + 
 +  * //N/A// 
 +== Remarks == 
 +  * //N/A// 
 + 
 +== Return Value == 
 +  * Type:​Object 
 +  * Description:​N/​A 
 + 
 +== Parameters ​== 
 +<div newline></​div>​ 
 +==== Public Properties ==== 
 +** {{wiki:​PublicProperty.gif|}} GeoImage **
  
-[[#Public Properties|Go Back]] 
-==== GeoImage ==== 
 This property gets and sets the GeoImage used for the texture fill. This property gets and sets the GeoImage used for the texture fill.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +None 
-| [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] ​ |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
  
 +** {{wiki:​PublicProperty.gif|}} DrawingRectangleF **
 +
 +This property gets and sets the screen rectangle used to fill the texture.
 +== Remarks ==
 +None
 +== Return Value ==
 +  * Type:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
 +
 +** {{wiki:​PublicProperty.gif|}} GeoWrapMode **
  
-[[#Public Properties|Go Back]] 
-==== GeoWrapMode ==== 
 This property gets and sets the wrap mode that is used to determine how an area is filled if the area is larger than the texture. This property gets and sets the wrap mode that is used to determine how an area is filled if the area is larger than the texture.
-=== Remarks ​===+== Remarks ==
 This property gets and sets the wrap mode that is used to determine how an area is filled if the area is larger than the texture. This property gets and sets the wrap mode that is used to determine how an area is filled if the area is larger than the texture.
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]]
-| [[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] ​  |+
  
 +** {{wiki:​PublicProperty.gif|}} Id **
  
-[[#Public Properties|Go Back]] +N/A 
-==== Id ==== +== Remarks ​== 
-The id of the GeoBrush. This is always used as a key when in the cached brushes. +N/A 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:Int64
-| Int64 |+
  
- +==== Protected Properties ==== 
-[[#Public Properties|Go Back]] +==== Public Events ====
-===== Protected Properties ​===== +
-===== Public Events ===== +
-__NOTOC__ +
-[[Category:​MapSuiteCore]] +
-[[Category:​ThinkGeo.MapSuite.Core]] +
-[[Category:​UpdateDocumentation]]+
  
thinkgeo.mapsuite.core.geotexturebrush.1440998717.txt.gz · Last modified: 2015/08/31 05:25 by admin

Page Tools