User Tools

Site Tools

Trace:
thinkgeo.mapsuite.portablecore.geotexturebrush

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.portablecore.geotexturebrush [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.portablecore.geotexturebrush [2017/03/16 21:59] (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.PortableCore.GeoTextureBrush ======+====== ThinkGeo.MapSuite.Core.GeoTextureBrush ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 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.PortableCore.GeoBrush]] +    *ThinkGeo.MapSuite.Core.GeoBrush 
-***[[ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoImage|GeoImage]] ​  ​| ​   | This is a constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoTextureBrush(GeoImage,​ DrawingRectangleF)|GeoTextureBrush]] ​  | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]],​ [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]] ​  ​| ​   | This is a constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoTextureBrush(GeoImage,​ GeoWrapMode)|GeoTextureBrush]] ​  | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]],​ [[ThinkGeo.MapSuite.PortableCore.GeoWrapMode|GeoWrapMode]] ​  ​| ​   | This is a constructor for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoTextureBrush(GeoImage,​ GeoWrapMode,​ DrawingRectangleF)|GeoTextureBrush]] ​  | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]],​ [[ThinkGeo.MapSuite.PortableCore.GeoWrapMode|GeoWrapMode]],​ [[ThinkGeo.MapSuite.PortableCore.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.
  
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} GeoTextureBrush(GeoImage,​DrawingRectangleF) **
 +
 +  * //This is a constructor for the class.//
 +== Remarks ==
 +  * //This method allows you to pass in a rectangle in screen coordinates to determine how much of the area is textured.//
 +== Parameters ==
 +  * //image//
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
 +    * Description:​This parameter is the image you want to use as the texture.
 +
 +  * //​rectangleF//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
 +    * Description:​This parameter is a rectangle (in screen coordinates) that specifies the area you want to use for the texture.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} GeoTextureBrush(GeoImage,​GeoWrapMode) **
 +
 +  * //This is a constructor for the class.//
 +== Remarks ==
 +  * //None//
 +== Parameters ==
 +  * //image//
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
 +    * Description:​This parameter is the image you want to use as the texture.
 +
 +  * //​wrapMode//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]]
 +    * Description:​This parameter determines the way the texture wraps when the area to fill is larger than the texture.
 +
 +<div newline></​div>​
 +** {{wiki:​PublicMethod.gif|}} GeoTextureBrush(GeoImage,​GeoWrapMode,​DrawingRectangleF) **
 +
 +  * //This is a constructor for the class.//
 +== Remarks ==
 +  * //None//
 +== Parameters ==
 +  * //image//
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
 +    * Description:​This parameter is the image you want to use as the texture.
 +
 +  * //​wrapMode//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]]
 +    * Description:​This parameter determines the way the texture wraps when the area to fill is larger than the texture.
 +
 +  * //​rectangleF//​
 +    * Type:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
 +    * Description:​This parameter is a rectangle (in screen coordinates) that specifies the area you want to use for the texture.
 +
 +<div newline></​div>​
 +==== Protected Constructors ====
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} CloneDeep() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] ​  ​| ​   | [[ThinkGeo.MapSuite.PortableCore.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 ==== +  * //N/A// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks ​== 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​CloneDeepCore()|CloneDeepCore]] ​  ​| ​   | [[ThinkGeo.MapSuite.PortableCore.GeoBrush|GeoBrush]] ​  | Create a copy of GeoBrush using the deep clone process. The default implementation uses serialization. ​  | +  * //N/A//
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] 
-| {{wiki:PublicProperty.gif|Public Property}}[[#​DrawingRectangleF|DrawingRectangleF]] ​  ​| ​[[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]   |    | This property gets and sets the screen rectangle used to fill the texture. ​  | +  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#​GeoImage|GeoImage]] ​  | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]] ​  ​| ​   | This property gets and sets the GeoImage used for the texture fill.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​GeoWrapMode|GeoWrapMode]] ​  | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoBrush|GeoBrush]] ​  | The id of the GeoBrush. This is always used as a key when in the cached brushes. ​  |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} ToString() **
  
-==== Public Events ==== +  * //N/A// 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +  * //N/A//
  
-===== Public Constructors ===== +== Return Value == 
-==== GeoTextureBrush(GeoImage) ==== +  ​* Type:String 
-This is a constructor for the class. +  * Description:N/A
-=== 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.PortableCore.GeoImage|GeoImage]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> ​  | This parameter is the image you want to use as the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +== Parameters == 
-==== GeoTextureBrush(GeoImage,​ DrawingRectangleF) ==== +<div newline></​div> 
-This is a constructor for the class. +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-=== 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.PortableCore.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.PortableCore.GeoImage -->   | This parameter is the image you want to use as the texture. ​  | +
-| rectangleF ​  | [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]<​!-- ThinkGeo.MapSuite.PortableCore.DrawingRectangleF --> ​  | This parameter is a rectangle ​(in screen coordinates) that specifies the area you want to use for the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +  * //N/A// 
-==== GeoTextureBrush(GeoImage,​ GeoWrapMode) ==== +== Remarks ​== 
-This is a constructor for the class. +  ​* //N/A//
-=== Overloads === +
-This constructor allows you to pass in the image and the wrap mode. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^ +
-| image   | [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> ​  | This parameter is the image you want to use as the texture. ​  | +
-| wrapMode ​  | [[ThinkGeo.MapSuite.PortableCore.GeoWrapMode|GeoWrapMode]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoWrapMode --> ​  | This parameter determines the way the texture wraps when the area to fill is larger than the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +== Return Value == 
-==== GeoTextureBrush(GeoImage,​ GeoWrapMode,​ DrawingRectangleF) ​==== +  ​* Type:Boolean 
-This is a constructor for the class. +  * Description:N/A
-=== 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.PortableCore.GeoImage|GeoImage]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> ​  | This parameter is the image you want to use as the texture. ​  | +
-| wrapMode ​  | [[ThinkGeo.MapSuite.PortableCore.GeoWrapMode|GeoWrapMode]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoWrapMode --> ​  | This parameter determines the way the texture wraps when the area to fill is larger than the texture. ​  | +
-| rectangleF ​  | [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]<​!-- ThinkGeo.MapSuite.PortableCore.DrawingRectangleF --> ​  | This parameter is a rectangle (in screen coordinates) that specifies the area you want to use for the texture. ​  |+
  
-[[#Public Constructors|Go Back]] +== Parameters ​== 
-===== Protected Constructors ===== +  * //obj// 
-===== Public Methods ===== +    * Type:Object 
-==== CloneDeep() ==== +    ​* ​Description:N/A
-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.PortableCore.GeoBrush|GeoBrush]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> ​  ​| ​A cloned GeoBrush. ​  |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^+** {{wiki:​PublicMethod.gif|}} GetHashCode() **
  
-<!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== Equals(Object) ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^ +  ​* Type:Int32 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetHashCode() ​==== +** {{wiki:​PublicMethod.gif|}} GetType() **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  * Type:Type 
-==== GetType() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +==== Protected Methods ==== 
 +** {{wiki:​ProtectedMethod.gif|}} CloneDeepCore() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== ToString() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:​[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-===== Protected Methods ===== +** {{wiki:ProtectedMethod.gif|}} Finalize() **
-==== CloneDeepCore() ==== +
-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.PortableCore.GeoBrush|GeoBrush]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> ​  | A cloned GeoBrush. ​  |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== Finalize() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks ​== 
-==== MemberwiseClone() ==== +  * //N/A//
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Object 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters == 
-[[#​Protected Methods|Go Back]] +<div newline></​div> 
-===== Public Properties ​===== +==== Public Properties ==== 
-==== DrawingRectangleF ==== +** {{wiki:​PublicProperty.gif|}} GeoImage **
-This property gets and sets the screen rectangle used to fill the texture. +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.PortableCore.DrawingRectangleF|DrawingRectangleF]]<​!-- ThinkGeo.MapSuite.PortableCore.DrawingRectangleF --> ​  |+
  
-<!-- ThinkGeo.MapSuite.PortableCore.GeoTextureBrush --> +  * //This property gets and sets the GeoImage used for the texture fill.// 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== GeoImage ==== +  * //None// 
-This property gets and sets the GeoImage used for the texture fill. +== Return Value == 
-=== Return Value === +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
-^ Return ​Type ^ +
-| [[ThinkGeo.MapSuite.PortableCore.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.PortableCore.GeoImage --> ​  |+
  
-<!-- ThinkGeo.MapSuite.PortableCore.GeoTextureBrush --> +** {{wiki:​PublicProperty.gif|}} DrawingRectangleF **
-[[#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. +
-=== 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. +
-=== Return Value === +
-^ Return Type ^ +
-| [[ThinkGeo.MapSuite.PortableCore.GeoWrapMode|GeoWrapMode]]<​!-- ThinkGeo.MapSuite.PortableCore.GeoWrapMode --> ​  |+
  
-<!-- ThinkGeo.MapSuite.PortableCore.GeoTextureBrush --> +  * //This property gets and sets the screen rectangle used to fill the texture.// 
-[[#Public Properties|Go Back]] +== Remarks ​== 
-==== Id ==== +  * //None// 
-The id of the GeoBrush. This is always used as a key when in the cached brushes. +== Return Value == 
-=== Return Value === +  ​* ​Type:​[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
-^ Return ​Type ^ +
-| Int64<​!-- System.Int64 --> ​  |+
  
-<!-- ThinkGeo.MapSuite.PortableCore.GeoBrush --> +** {{wiki:​PublicProperty.gif|}} GeoWrapMode ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +  * //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.// 
-===== Public Events ===== +== Remarks == 
-__NOTOC__ +  * //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.// 
-[[Category:​MapSuitePortableCore]] +== Return Value == 
-[[Category:​ThinkGeo.MapSuite.PortableCore]] +  * Type:[[ThinkGeo.MapSuite.Core.GeoWrapMode|GeoWrapMode]] 
-[[Category:​UpdateDocumentation]]+ 
 +** {{wiki:​PublicProperty.gif|}} Id ** 
 + 
 +  * //N/A// 
 +== Remarks == 
 +  * //N/A// 
 +== Return Value == 
 +  * Type:​Int64 
 + 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.portablecore.geotexturebrush.1440040132.txt.gz · Last modified: 2015/09/21 08:09 (external edit)

Page Tools