SpriteLibrary

+ +	Name	Description
	SpriteController(PictureBox)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. You want to have the PictureBox already defined, and a background image + already set for the PictureBox. +
	SpriteController(PictureBox, EventHandler)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. +

+ +	Name	Description
	BackgroundImage	+ The Background Image on which the sprites are drawn. This image ends up having + sprite parts on it. The OriginalImage is the version that is clean. Use + ReplaceOriginalImage to replace the background Image. +
	OriginalImage	+ The Image from which the background is taken when we erase sprites. The BackgroundImage + is the image that contains images of the sprites as well as the background image. Use + ReplaceOriginalImage to replace this and the BackgroundImage. +
	SpriteCount	+ The count of all the sprites the controller knows about. This includes named + sprites, which may not be visible. +

+ +	Name	Description
	AddSprite	+ Add the specified sprite to the list of sprites we know about. You usually do not need to do this. + Sprites add themselves to the controller when you create a new sprite. +
	AdjustPoint	+ Adjust an image point so that it conforms to the picturebox. +
	AdjustRectangle	+ Adjust a rectangle that is based on the image, according to the stretch of the picturebox +
	AllSprites	+ Return a list of all sprites +
	ChangeTickInterval	+ Change the Tick Interval. By default, the spritecontroller does a tick every 10ms, which + is very fast. Some people may prefer it to happen less regularly. Must be > 5, and less than 1001 +
	CountSpritesBasedOff	+ Count the number of sprites that were duplicated from the sprite with the specified name. When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function will count those duplicated sprites. +
	DestroyAllSprites	+ Remove all sprites (even named sprites that have not yet been displayed) +
	DestroySprite	+ Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + and remove itself from the controller. After it is destroyed, it is completely gone. +
	DuplicateSprite(String)	+ Find a sprite that has been named with the specified name. Then duplicate that sprite +
	DuplicateSprite(Sprite)	+ Make a duplicate of the specified sprite. The duplicate does not yet have a location. +
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invalidate(Boolean)	+ Invalidate the entire image on which the sprites are drawn +
	Invalidate(Rectangle, Boolean)	+ Invalidate a rectangle that is specified in image coordinates +
	IsKeyPressed	+ Check to see if any keys are pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	IsKeyPressed(Keys)	+ Check to see if the given key is pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	KeysPressed	+ Return a list of all the keys that are currently pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NameSprite	+ Find the specified Sprite in the controller and change its name to the specified string. + You can do the same thing with Sprite.SetName(Name)
	Pause	+ Pause everything. It loops through all the sprites in the SpriteController and sends the specified + SpritePauseType to each one. Look at the documentation for SpritePauseType to determine which pause + type to use. +
	PlaceSpriteBehind	+ Change the display order of the sprites such that the specified sprite appears behind the other sprite. +
	PlaceSpriteInFrontOf	+ Make the sprite go in front of the specified sprite. +
	RegisterKeyDownFunction	+ If you want to have a KeyDown function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	RegisterKeyUpFunction	+ If you want to have a KeyUp function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	ReplaceOriginalImage	+ Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +
	ReplaceOriginalImage(Image)	+ Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background + Examples + Replacing the background image is actually a lot more complex than you might imagine. Once you use the + below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + a number of small ways. + You need to tell the sprite controller that you are replacing the background image, + and you need to change the image to that image as well.Because the Images are actually + pointers to memory where the image sets, changes to one image will affect the other image.This goofs + things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + to invalidate itself.That does everything that is needed. + C# Copy void ReplaceBackground(Image NewBackground) +{ + if (MyController == null) return; + if (NewBackground == null) return; + + Image OneImage = new Bitmap(NewBackground); + MyController.ReplaceOriginalImage(OneImage); + + Image TwoImage = new Bitmap(NewBackground); + pb_map.BackgroundImage = TwoImage; + pb_map.Invalidate(); +}
	ResetKeypressState	+ Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + because a window has taken priority, or something has changed). Calling this function will reset + the stored memory of whether a key has been pressed. +
	ReturnAdjustmentRatio	+ Return an adjustment ratio. This is the image-size to picture-box ratio. + It is used for calculating precise pixels or picture-box locations. +
	ReturnPictureBoxAdjustedHeight	+ Return the height of an object in picture-box terms. It is basically the virtual height + of the sprite or other item. +
	ReturnPictureBoxAdjustedPoint	+ This does the reverse of an adjusted point. It takes a point on the image and + transforms it to one on the PictureBox +
	ReturnPictureBoxAdjustedWidth	+ Return the width of an object in picture-box terms. It takes the width of a sprite or other + item that is being displayed on the screen, and calculates the width as displayed in the + picture-box (taking into consideration stretching or shrinking) +
	ReturnPointAdjustedForImage	+ This takes a point, the location on a picturebox, and returns the corresponding point on the BackgroundImage. + Picturebox locations are "sloppy"; the background image locations are very precise. Since this takes a "sloppy" + number and returns a precise number, it does some rounding to figure out where the specified location is. +
	SoundIsFinished	+ Check to see if the specified sound has finished playing +
	SoundPlay	+ Play a sound that we can check to see if it has completed. +
	SpriteBackwards	+ Change the display order of the specified sprite so it is more likely to go behind all other sprites. +
	SpriteForwards	+ Change the display order of the specified sprite so it is more likely to go in front of other sprites +
	SpriteFromName	+ Find a sprite that has a specified name. This returns the actual sprite with that name. + You usually want to use DuplicateSprite(Name) to clone the sprite and get one you can + destroy. If you destroy a named sprite without duplicating it, you may end up losing + it for the remainder of the program. +
	SpritesAtImagePoint	+ This takes a point, as as specified on the image, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the background image coordinates. Use SpritesAdPoint() if you are doing something based off + a MouseUp or MouseDown function. This is used for functions based on sprite location or based off the absoloute + location (using the background image location is much more precise than the visible location in the picturebox) +
	SpritesAtPoint	+ This takes a point, as given by the mouse-click args, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the picturebox coordinates. So you can use this directly from a MouseDown or MouseUp function. +
	SpritesBasedOff	+ Return all sprites that were based off a particular sprite name. + When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function returns a list of those + duplicated sprites. +
	SpritesBasedOffAnything	+ Return a list of all sprites which are not master sprites (which are duplicates of something) +
	SpritesInImageRectangle	+ Return a list of all the sprites that intersect with the given background-image-based rectangle +
	SpritesThatHaveBeenDrawn	+ Return a list of all sprites which have been drawn on the image +
	SpriteToBack	+ Change the display order of the specified sprite so it goes behind all other sprites. +
	SpriteToFront	+ Change the display order of the specified sprite so it goes in front of all other sprites. +
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnPause	+ un-Pause everything. This will send the specified SpritePauseType unpause command + to all sprites. +

+ +	Name	Description
	DoTick	+ The function called by the timer every 10 millisecods This is usually where you will do the majority of the work. + You can define this manually, or when you instantiate the SpriteController

+ +	Name	Description
	OptimizeForLargeSpriteImages	+ If your sprite images need substantial growing or shrinking when displayed, you can try setting this to "true" + to see if it makes it run any faster. What it does is to resize the image once, and keep a cached copy of that + image at that size. If you use the same sprite, but with different sizes, setting this to "True" may actually slow + down the game instead of speeding it up. +
	RandomNumberGenerator	+ Since everything needs a random number generator, we make one that should be accessible throughout your program. +
	SpriteComparisonDelegate	+ Allow the sprite sort-method to be overridden. +

+ +	Name	Description
	AddAnimation(Image)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Image, Size)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Image, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Int32, Int32)	+ Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand. +
	AddAnimation(Image, Int32, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Int32, Boolean, Boolean)	+ Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand using the MirrorHorizontally or MirrorVertically booleans. +
	AddAnimation(Image, Int32, Int32, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +
	AddAnimation(Point, Image, Int32, Int32, Int32, Int32)	+ Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +

+ +	Name	Description
	MoveTo(ListPoint)	+ Tell the sprite to move towards each point in turn. The sprite will move in a straight line until the first point. + From there it moves to the next point, until it has reached the last point. Every time it reaches a point, the + SpriteArrivedAtWaypoint event is triggered. When it reaches the final point in the list, the SpriteArrivedAtEndPoint + event is triggered. While the sprite is moving, the SpriteReachedEndPoint attribute is set to false. When it has + arrived, it is set to true. +
	MoveTo(Point)	+ Tell the Sprite to move towards a destination. You need to give the sprite a MovementSpeed + and tell the sprite that it can automatically move. But the sprite will begin a journey towards + that point at the MovementSpeed you have set. When it gets to the point, the SpriteArrivedAtEndPoint event + will fire off. Also, the SpriteReachedEnd bool will be true. +
	MoveTo(Sprite)	+ Move to where the destination sprite currently is at. This is a dumb move. It does not take into + consideration the movement direction of the destination sprite. So the moving sprite does need to be + moving a bit faster than the sprite you are trying to hit for it to do so. +

+ +	Name	Description
	AddSprite	+ Add the specified sprite to the list of sprites we know about. You usually do not need to do this. + Sprites add themselves to the controller when you create a new sprite. +
	AdjustPoint	+ Adjust an image point so that it conforms to the picturebox. +
	AdjustRectangle	+ Adjust a rectangle that is based on the image, according to the stretch of the picturebox +
	AllSprites	+ Return a list of all sprites +
	ChangeTickInterval	+ Change the Tick Interval. By default, the spritecontroller does a tick every 10ms, which + is very fast. Some people may prefer it to happen less regularly. Must be > 5, and less than 1001 +
	CountSpritesBasedOff	+ Count the number of sprites that were duplicated from the sprite with the specified name. When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function will count those duplicated sprites. +
	DestroyAllSprites	+ Remove all sprites (even named sprites that have not yet been displayed) +
	DestroySprite	+ Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + and remove itself from the controller. After it is destroyed, it is completely gone. +
	DuplicateSprite(String)	+ Find a sprite that has been named with the specified name. Then duplicate that sprite +
	DuplicateSprite(Sprite)	+ Make a duplicate of the specified sprite. The duplicate does not yet have a location. +
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invalidate(Boolean)	+ Invalidate the entire image on which the sprites are drawn +
	Invalidate(Rectangle, Boolean)	+ Invalidate a rectangle that is specified in image coordinates +
	IsKeyPressed	+ Check to see if any keys are pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	IsKeyPressed(Keys)	+ Check to see if the given key is pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	KeysPressed	+ Return a list of all the keys that are currently pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. +
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NameSprite	+ Find the specified Sprite in the controller and change its name to the specified string. + You can do the same thing with Sprite.SetName(Name)
	Pause	+ Pause everything. It loops through all the sprites in the SpriteController and sends the specified + SpritePauseType to each one. Look at the documentation for SpritePauseType to determine which pause + type to use. +
	PlaceSpriteBehind	+ Change the display order of the sprites such that the specified sprite appears behind the other sprite. +
	PlaceSpriteInFrontOf	+ Make the sprite go in front of the specified sprite. +
	RegisterKeyDownFunction	+ If you want to have a KeyDown function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	RegisterKeyUpFunction	+ If you want to have a KeyUp function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +
	ReplaceOriginalImage	+ Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +
	ReplaceOriginalImage(Image)	+ Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background + Examples + Replacing the background image is actually a lot more complex than you might imagine. Once you use the + below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + a number of small ways. + You need to tell the sprite controller that you are replacing the background image, + and you need to change the image to that image as well.Because the Images are actually + pointers to memory where the image sets, changes to one image will affect the other image.This goofs + things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + to invalidate itself.That does everything that is needed. + C# Copy void ReplaceBackground(Image NewBackground) +{ + if (MyController == null) return; + if (NewBackground == null) return; + + Image OneImage = new Bitmap(NewBackground); + MyController.ReplaceOriginalImage(OneImage); + + Image TwoImage = new Bitmap(NewBackground); + pb_map.BackgroundImage = TwoImage; + pb_map.Invalidate(); +}
	ResetKeypressState	+ Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + because a window has taken priority, or something has changed). Calling this function will reset + the stored memory of whether a key has been pressed. +
	ReturnAdjustmentRatio	+ Return an adjustment ratio. This is the image-size to picture-box ratio. + It is used for calculating precise pixels or picture-box locations. +
	ReturnPictureBoxAdjustedHeight	+ Return the height of an object in picture-box terms. It is basically the virtual height + of the sprite or other item. +
	ReturnPictureBoxAdjustedPoint	+ This does the reverse of an adjusted point. It takes a point on the image and + transforms it to one on the PictureBox +
	ReturnPictureBoxAdjustedWidth	+ Return the width of an object in picture-box terms. It takes the width of a sprite or other + item that is being displayed on the screen, and calculates the width as displayed in the + picture-box (taking into consideration stretching or shrinking) +
	ReturnPointAdjustedForImage	+ This takes a point, the location on a picturebox, and returns the corresponding point on the BackgroundImage. + Picturebox locations are "sloppy"; the background image locations are very precise. Since this takes a "sloppy" + number and returns a precise number, it does some rounding to figure out where the specified location is. +
	SoundIsFinished	+ Check to see if the specified sound has finished playing +
	SoundPlay	+ Play a sound that we can check to see if it has completed. +
	SpriteBackwards	+ Change the display order of the specified sprite so it is more likely to go behind all other sprites. +
	SpriteForwards	+ Change the display order of the specified sprite so it is more likely to go in front of other sprites +
	SpriteFromName	+ Find a sprite that has a specified name. This returns the actual sprite with that name. + You usually want to use DuplicateSprite(Name) to clone the sprite and get one you can + destroy. If you destroy a named sprite without duplicating it, you may end up losing + it for the remainder of the program. +
	SpritesAtImagePoint	+ This takes a point, as as specified on the image, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the background image coordinates. Use SpritesAdPoint() if you are doing something based off + a MouseUp or MouseDown function. This is used for functions based on sprite location or based off the absoloute + location (using the background image location is much more precise than the visible location in the picturebox) +
	SpritesAtPoint	+ This takes a point, as given by the mouse-click args, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the picturebox coordinates. So you can use this directly from a MouseDown or MouseUp function. +
	SpritesBasedOff	+ Return all sprites that were based off a particular sprite name. + When you use a + SpriteController.DuplicateSprite(string) + command, it creates a new sprite that is based off the named sprite. This function returns a list of those + duplicated sprites. +
	SpritesBasedOffAnything	+ Return a list of all sprites which are not master sprites (which are duplicates of something) +
	SpritesInImageRectangle	+ Return a list of all the sprites that intersect with the given background-image-based rectangle +
	SpritesThatHaveBeenDrawn	+ Return a list of all sprites which have been drawn on the image +
	SpriteToBack	+ Change the display order of the specified sprite so it goes behind all other sprites. +
	SpriteToFront	+ Change the display order of the specified sprite so it goes in front of all other sprites. +
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnPause	+ un-Pause everything. This will send the specified SpritePauseType unpause command + to all sprites. +

+ +	Name	Description
	ReplaceOriginalImage	+ Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +
	ReplaceOriginalImage(Image)	+ Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background + Examples + Replacing the background image is actually a lot more complex than you might imagine. Once you use the + below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + a number of small ways. + You need to tell the sprite controller that you are replacing the background image, + and you need to change the image to that image as well.Because the Images are actually + pointers to memory where the image sets, changes to one image will affect the other image.This goofs + things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + to invalidate itself.That does everything that is needed. + C# Copy void ReplaceBackground(Image NewBackground) +{ + if (MyController == null) return; + if (NewBackground == null) return; + + Image OneImage = new Bitmap(NewBackground); + MyController.ReplaceOriginalImage(OneImage); + + Image TwoImage = new Bitmap(NewBackground); + pb_map.BackgroundImage = TwoImage; + pb_map.Invalidate(); +}

+ +	Name	Description
	SpriteController(PictureBox)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. You want to have the PictureBox already defined, and a background image + already set for the PictureBox. +
	SpriteController(PictureBox, EventHandler)	+ Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. +

').text(value).html(); +} + +// Build the child entries of a TOC entry +function BuildChildren(tocDiv, data) +{ + var childLevel = +tocDiv.attr("data-toclevel") + 1; + var childTocLevel = childLevel >= 10 ? 10 : childLevel; + var elements = data.getElementsByTagName("HelpTOCNode"); + + var isRoot = true; + + if(data.getElementsByTagName("HelpTOC").length == 0) + { + // The first node is the root node of this group, don't show it again + isRoot = false; + } + + for(var i = elements.length - 1; i > 0 || (isRoot && i == 0); i--) + { + var childHRef, childId = elements[i].getAttribute("Url"); + + if(childId != null && childId.length > 5) + { + // The Url attribute has the form "html/{childId}.htm" + childHRef = childId.substring(5, childId.length); + childId = childId.substring(5, childId.lastIndexOf(".")); + } + else + { + // The Id attribute is in raw form. There is no URL (empty container node). In this case, we'll + // just ignore it and go nowhere. It's a rare case that isn't worth trying to get the first child. + // Instead, we'll just expand the node (see below). + childHRef = "#"; + childId = elements[i].getAttribute("Id"); + } + + var existingItem = null; + + tocDiv.nextAll().each(function() + { + if(!existingItem && $(this).children().last("a").attr("tocid") == childId) + { + existingItem = $(this); + } + }); + + if(existingItem != null) + { + // First move the children of the existing item + var existingChildLevel = +existingItem.attr("data-toclevel"); + var doneMoving = false; + var inserter = tocDiv; + + existingItem.nextAll().each(function() + { + if(!doneMoving && +$(this).attr("data-toclevel") > existingChildLevel) + { + inserter.after($(this)); + inserter = $(this); + $(this).attr("data-toclevel", +$(this).attr("data-toclevel") + childLevel - existingChildLevel); + + if($(this).hasClass("current")) + $(this).attr("class", "toclevel" + (+$(this).attr("data-toclevel") + " current")); + else + $(this).attr("class", "toclevel" + (+$(this).attr("data-toclevel"))); + } + else + { + doneMoving = true; + } + }); + + // Now move the existing item itself + tocDiv.after(existingItem); + existingItem.attr("data-toclevel", childLevel); + existingItem.attr("class", "toclevel" + childLevel); + } + else + { + var hasChildren = elements[i].getAttribute("HasChildren"); + var childTitle = HtmlEncode(elements[i].getAttribute("Title")); + var expander = ""; + + if(hasChildren) + expander = ""; + + var text = "

" + + expander + "" + + childTitle + "

"; + + tocDiv.after(text); + } + } + + tocDiv.attr("data-childrenloaded", true); +} + +// Collapse a TOC entry +function Collapse(tocDiv) +{ + // Hide all the TOC elements after item, until we reach one with a data-toclevel less than or equal to the + // current item's value. + var tocLevel = +tocDiv.attr("data-toclevel"); + var done = false; + + tocDiv.nextAll().each(function() + { + if(!done && +$(this).attr("data-toclevel") > tocLevel) + { + $(this).hide(); + } + else + { + done = true; + } + }); +} + +// Expand a TOC entry +function Expand(tocDiv) +{ + // Show all the TOC elements after item, until we reach one with a data-toclevel less than or equal to the + // current item's value + var tocLevel = +tocDiv.attr("data-toclevel"); + var done = false; + + tocDiv.nextAll().each(function() + { + if(done) + { + return; + } + + var childTocLevel = +$(this).attr("data-toclevel"); + + if(childTocLevel == tocLevel + 1) + { + $(this).show(); + + if($(this).children("a").first().hasClass("tocExpanded")) + { + Expand($(this)); + } + } + else if(childTocLevel > tocLevel + 1) + { + // Ignore this node, handled by recursive calls + } + else + { + done = true; + } + }); +} + +// This is called to prepare for dragging the sizer div +function OnMouseDown(event) +{ + document.addEventListener("mousemove", OnMouseMove, true); + document.addEventListener("mouseup", OnMouseUp, true); + event.preventDefault(); +} + +// Resize the TOC as the sizer is dragged +function OnMouseMove(event) +{ + tocWidth = (event.clientX > 700) ? 700 : (event.clientX < 100) ? 100 : event.clientX; + + ResizeToc(); +} + +// Finish the drag operation when the mouse button is released +function OnMouseUp(event) +{ + document.removeEventListener("mousemove", OnMouseMove, true); + document.removeEventListener("mouseup", OnMouseUp, true); + + SetCookie("TocWidth", tocWidth); +} + +// Search functions + +// Transfer to the search page from a topic +function TransferToSearchPage() +{ + var searchText = document.getElementById("SearchTextBox").value.trim(); + + if(searchText.length != 0) + document.location.replace(encodeURI("../search.html?SearchText=" + searchText)); +} + +// Initiate a search when the search page loads +function OnSearchPageLoad() +{ + var queryString = decodeURI(document.location.search); + + if(queryString != "") + { + var idx, options = queryString.split(/[\?\=\&]/); + + for(idx = 0; idx < options.length; idx++) + if(options[idx] == "SearchText" && idx + 1 < options.length) + { + document.getElementById("txtSearchText").value = options[idx + 1]; + PerformSearch(); + break; + } + } +} + +// Perform a search using the best available method +function PerformSearch() +{ + var searchText = document.getElementById("txtSearchText").value; + var sortByTitle = document.getElementById("chkSortByTitle").checked; + var searchResults = document.getElementById("searchResults"); + + if(searchText.length == 0) + { + searchResults.innerHTML = "Nothing found"; + return; + } + + searchResults.innerHTML = "Searching..."; + + // Determine the search method if not done already. The ASPX and PHP searches are more efficient as they + // run asynchronously server-side. If they can't be used, it defaults to the client-side script below which + // will work but has to download the index files. For large help sites, this can be inefficient. + if(searchMethod == 0) + searchMethod = DetermineSearchMethod(); + + if(searchMethod == 1) + { + $.ajax({ + type: "GET", + url: encodeURI("SearchHelp.aspx?Keywords=" + searchText + "&SortByTitle=" + sortByTitle), + success: function(html) + { + searchResults.innerHTML = html; + } + }); + + return; + } + + if(searchMethod == 2) + { + $.ajax({ + type: "GET", + url: encodeURI("SearchHelp.php?Keywords=" + searchText + "&SortByTitle=" + sortByTitle), + success: function(html) + { + searchResults.innerHTML = html; + } + }); + + return; + } + + // Parse the keywords + var keywords = ParseKeywords(searchText); + + // Get the list of files. We'll be getting multiple files so we need to do this synchronously. + var fileList = []; + + $.ajax({ + type: "GET", + url: "fti/FTI_Files.json", + dataType: "json", + async: false, + success: function(data) + { + $.each(data, function(key, val) + { + fileList[key] = val; + }); + } + }); + + var letters = []; + var wordDictionary = {}; + var wordNotFound = false; + + // Load the keyword files for each keyword starting letter + for(var idx = 0; idx < keywords.length && !wordNotFound; idx++) + { + var letter = keywords[idx].substring(0, 1); + + if($.inArray(letter, letters) == -1) + { + letters.push(letter); + + $.ajax({ + type: "GET", + url: "fti/FTI_" + letter.charCodeAt(0) + ".json", + dataType: "json", + async: false, + success: function(data) + { + var wordCount = 0; + + $.each(data, function(key, val) + { + wordDictionary[key] = val; + wordCount++; + }); + + if(wordCount == 0) + wordNotFound = true; + } + }); + } + } + + if(wordNotFound) + searchResults.innerHTML = "Nothing found"; + else + searchResults.innerHTML = SearchForKeywords(keywords, fileList, wordDictionary, sortByTitle); +} + +// Determine the search method by seeing if the ASPX or PHP search pages are present and working +function DetermineSearchMethod() +{ + var method = 3; + + try + { + $.ajax({ + type: "GET", + url: "SearchHelp.aspx", + async: false, + success: function(html) + { + if(html.substring(0, 8) == "") + method = 1; + } + }); + + if(method == 3) + $.ajax({ + type: "GET", + url: "SearchHelp.php", + async: false, + success: function(html) + { + if(html.substring(0, 8) == "") + method = 2; + } + }); + } + catch(e) + { + } + + return method; +} + +// Split the search text up into keywords +function ParseKeywords(keywords) +{ + var keywordList = []; + var checkWord; + var words = keywords.split(/\W+/); + + for(var idx = 0; idx < words.length; idx++) + { + checkWord = words[idx].toLowerCase(); + + if(checkWord.length > 2) + { + var charCode = checkWord.charCodeAt(0); + + if((charCode < 48 || charCode > 57) && $.inArray(checkWord, keywordList) == -1) + keywordList.push(checkWord); + } + } + + return keywordList; +} + +// Search for keywords and generate a block of HTML containing the results +function SearchForKeywords(keywords, fileInfo, wordDictionary, sortByTitle) +{ + var matches = [], matchingFileIndices = [], rankings = []; + var isFirst = true; + + for(var idx = 0; idx < keywords.length; idx++) + { + var word = keywords[idx]; + var occurrences = wordDictionary[word]; + + // All keywords must be found + if(occurrences == null) + return "Nothing found"; + + matches[word] = occurrences; + var occurrenceIndices = []; + + // Get a list of the file indices for this match. These are 64-bit numbers but JavaScript only does + // bit shifts on 32-bit values so we divide by 2^16 to get the same effect as ">> 16" and use floor() + // to truncate the result. + for(var ind in occurrences) + occurrenceIndices.push(Math.floor(occurrences[ind] / Math.pow(2, 16))); + + if(isFirst) + { + isFirst = false; + + for(var matchInd in occurrenceIndices) + matchingFileIndices.push(occurrenceIndices[matchInd]); + } + else + { + // After the first match, remove files that do not appear for all found keywords + for(var checkIdx = 0; checkIdx < matchingFileIndices.length; checkIdx++) + if($.inArray(matchingFileIndices[checkIdx], occurrenceIndices) == -1) + { + matchingFileIndices.splice(checkIdx, 1); + checkIdx--; + } + } + } + + if(matchingFileIndices.length == 0) + return "Nothing found"; + + // Rank the files based on the number of times the words occurs + for(var fileIdx = 0; fileIdx < matchingFileIndices.length; fileIdx++) + { + // Split out the title, filename, and word count + var matchingIdx = matchingFileIndices[fileIdx]; + var fileIndex = fileInfo[matchingIdx].split(/\0/); + + var title = fileIndex[0]; + var filename = fileIndex[1]; + var wordCount = parseInt(fileIndex[2]); + var matchCount = 0; + + for(var idx = 0; idx < keywords.length; idx++) + { + occurrences = matches[keywords[idx]]; + + for(var ind in occurrences) + { + var entry = occurrences[ind]; + + // These are 64-bit numbers but JavaScript only does bit shifts on 32-bit values so we divide + // by 2^16 to get the same effect as ">> 16" and use floor() to truncate the result. + if(Math.floor(entry / Math.pow(2, 16)) == matchingIdx) + matchCount += (entry & 0xFFFF); + } + } + + rankings.push({ Filename: filename, PageTitle: title, Rank: matchCount * 1000 / wordCount }); + + if(rankings.length > 99) + break; + } + + rankings.sort(function(x, y) + { + if(!sortByTitle) + return y.Rank - x.Rank; + + return x.PageTitle.localeCompare(y.PageTitle); + }); + + // Format and return the results + var content = "
"; + + for(var r in rankings) + content += "
" + + rankings[r].PageTitle + "
"; + + content += "
"; + + if(rankings.length < matchingFileIndices.length) + content += "
Omitted " + (matchingFileIndices.length - rankings.length) + " more results
"; + + return content; +} diff --git a/SpriteLibrary/Doc/Help/scripts/branding.js b/SpriteLibrary/Doc/Help/scripts/branding.js new file mode 100644 index 0000000..3e55541 --- /dev/null +++ b/SpriteLibrary/Doc/Help/scripts/branding.js @@ -0,0 +1,560 @@ +//=============================================================================================================== +// System : Sandcastle Help File Builder +// File : branding.js +// Author : Eric Woodruff (Eric@EWoodruff.us) +// Updated : 10/08/2015 +// Note : Copyright 2014-2015, Eric Woodruff, All rights reserved +// Portions Copyright 2010-2014 Microsoft, All rights reserved +// +// This file contains the methods necessary to implement the language filtering, collapsible section, and +// copy to clipboard options. +// +// This code is published under the Microsoft Public License (Ms-PL). A copy of the license should be +// distributed with the code and can be found at the project website: https://GitHub.com/EWSoftware/SHFB. This +// notice, the author's name, and all copyright notices must remain intact in all applications, documentation, +// and source files. +// +// Date Who Comments +// ============================================================================================================== +// 05/04/2014 EFW Created the code based on the MS Help Viewer script +//=============================================================================================================== + +// The IDs of all code snippet sets on the same page are stored so that we can keep them in synch when a tab is +// selected. +var allTabSetIds = new Array(); + +// The IDs of language-specific text (LST) spans are used as dictionary keys so that we can get access to the +// spans and update them when the user changes to a different language tab. The values of the dictionary +// objects are pipe separated language-specific attributes (lang1=value|lang2=value|lang3=value). The language +// ID can be specific (cs, vb, cpp, etc.) or may be a neutral entry (nu) which specifies text common to multiple +// languages. If a language is not present and there is no neutral entry, the span is hidden for all languages +// to which it does not apply. +var allLSTSetIds = new Object(); + +// Help 1 persistence support. This code must appear inline. +var isHelp1; + +var curLoc = document.location + "."; + +if(curLoc.indexOf("mk:@MSITStore") == 0) +{ + isHelp1 = true; + curLoc = "ms-its:" + curLoc.substring(14, curLoc.length - 1); + document.location.replace(curLoc); +} +else + if(curLoc.indexOf("ms-its:") == 0) + isHelp1 = true; + else + isHelp1 = false; + +// The OnLoad method +function OnLoad(defaultLanguage) +{ + var defLang; + + if(typeof (defaultLanguage) == "undefined" || defaultLanguage == null || defaultLanguage == "") + defLang = "vb"; + else + defLang = defaultLanguage; + + // In MS Help Viewer, the transform the topic is ran through can move the footer. Move it back where it + // belongs if necessary. + try + { + var footer = document.getElementById("pageFooter") + + if(footer) + { + var footerParent = document.body; + + if(footer.parentElement != footerParent) + { + footer.parentElement.removeChild(footer); + footerParent.appendChild(footer); + } + } + } + catch(e) + { + } + + var language = GetCookie("CodeSnippetContainerLanguage", defLang); + + // If LST exists on the page, set the LST to show the user selected programming language + UpdateLST(language); + + // If code snippet groups exist, set the current language for them + if(allTabSetIds.length > 0) + { + var i = 0; + + while(i < allTabSetIds.length) + { + var tabCount = 1; + + // The tab count may vary so find the last one in this set + while(document.getElementById(allTabSetIds[i] + "_tab" + tabCount) != null) + tabCount++; + + tabCount--; + + // If not grouped, skip it + if(tabCount > 1) + SetCurrentLanguage(allTabSetIds[i], language, tabCount); + + i++; + } + } + + InitializeToc(); +} + +// This is just a place holder. The website script implements this function to initialize it's in-page TOC pane +function InitializeToc() +{ +} + +// This function executes in the OnLoad event and ChangeTab action on code snippets. The function parameter +// is the user chosen programming language. This function iterates through the "allLSTSetIds" dictionary object +// to update the node value of the LST span tag per the user's chosen programming language. +function UpdateLST(language) +{ + for(var lstMember in allLSTSetIds) + { + var devLangSpan = document.getElementById(lstMember); + + if(devLangSpan != null) + { + // There may be a carriage return before the LST span in the content so the replace function below + // is used to trim the whitespace at the end of the previous node of the current LST node. + if(devLangSpan.previousSibling != null && devLangSpan.previousSibling.nodeValue != null) + devLangSpan.previousSibling.nodeValue = devLangSpan.previousSibling.nodeValue.replace(/\s+$/, ""); + + var langs = allLSTSetIds[lstMember].split("|"); + var k = 0; + var keyValue; + + while(k < langs.length) + { + keyValue = langs[k].split("="); + + if(keyValue[0] == language) + { + devLangSpan.innerHTML = keyValue[1]; + + // Help 1 and MS Help Viewer workaround. Add a space if the following text element starts + // with a space to prevent things running together. + if(devLangSpan.parentNode != null && devLangSpan.parentNode.nextSibling != null) + { + if (devLangSpan.parentNode.nextSibling.nodeValue != null && + !devLangSpan.parentNode.nextSibling.nodeValue.substring(0, 1).match(/[.,);:!/?]/)) + { + devLangSpan.innerHTML = keyValue[1] + " "; + } + } + break; + } + + k++; + } + + // If not found, default to the neutral language. If there is no neutral language entry, clear the + // content to hide it. + if(k >= langs.length) + { + if(language != "nu") + { + k = 0; + + while(k < langs.length) + { + keyValue = langs[k].split("="); + + if(keyValue[0] == "nu") + { + devLangSpan.innerHTML = keyValue[1]; + + // Help 1 and MS Help Viewer workaround. Add a space if the following text element + // starts with a space to prevent things running together. + if(devLangSpan.parentNode != null && devLangSpan.parentNode.nextSibling != null) + { + if(devLangSpan.parentNode.nextSibling.nodeValue != null && + !devLangSpan.parentNode.nextSibling.nodeValue.substring(0, 1).match(/[.,);:!/?]/)) + { + devLangSpan.innerHTML = keyValue[1] + " "; + } + } + break; + } + + k++; + } + } + + if(k >= langs.length) + devLangSpan.innerHTML = ""; + } + } + } +} + +// Get the specified cookie. If not found, return the specified default value. +function GetCookie(cookieName, defaultValue) +{ + if(isHelp1) + { + try + { + var globals = Help1Globals; + + var value = globals.Load(cookieName); + + if(value == null) + value = defaultValue; + + return value; + } + catch(e) + { + return defaultValue; + } + } + + var cookie = document.cookie.split("; "); + + for(var i = 0; i < cookie.length; i++) + { + var crumb = cookie[i].split("="); + + if(cookieName == crumb[0]) + return unescape(crumb[1]) + } + + return defaultValue; +} + +// Set the specified cookie to the specified value +function SetCookie(name, value) +{ + if(isHelp1) + { + try + { + var globals = Help1Globals; + + globals.Save(name, value); + } + catch(e) + { + } + + return; + } + + var today = new Date(); + + today.setTime(today.getTime()); + + // Set the expiration time to be 60 days from now (in milliseconds) + var expires_date = new Date(today.getTime() + (60 * 1000 * 60 * 60 * 24)); + + document.cookie = name + "=" + escape(value) + ";expires=" + expires_date.toGMTString() + ";path=/"; +} + +// Add a language-specific text ID +function AddLanguageSpecificTextSet(lstId) +{ + var keyValue = lstId.split("?") + + allLSTSetIds[keyValue[0]] = keyValue[1]; +} + +var clipboardHandler; + +// Add a language tab set ID +function AddLanguageTabSet(tabSetId) +{ + allTabSetIds.push(tabSetId); + + // Create the clipboard handler on first use + if(clipboardHandler == null && typeof (Clipboard) == "function") + { + clipboardHandler = new Clipboard('.copyCodeSnippet', + { + text: function (trigger) + { + // Get the code to copy to the clipboard from the active tab of the given tab set + var i = 1, tabSetId = trigger.id; + var pos = tabSetId.indexOf('_'); + + if(pos == -1) + return ""; + + tabSetId = tabSetId.substring(0, pos); + + do + { + contentId = tabSetId + "_code_Div" + i; + tabTemp = document.getElementById(contentId); + + if(tabTemp != null && tabTemp.style.display != "none") + break; + + i++; + + } while(tabTemp != null); + + if(tabTemp == null) + return ""; + + return document.getElementById(contentId).innerText; + } + }); + } +} + +// Switch the active tab for all of other code snippets +function ChangeTab(tabSetId, language, snippetIdx, snippetCount) +{ + SetCookie("CodeSnippetContainerLanguage", language); + + SetActiveTab(tabSetId, snippetIdx, snippetCount); + + // If LST exists on the page, set the LST to show the user selected programming language + UpdateLST(language); + + var i = 0; + + while(i < allTabSetIds.length) + { + // We just care about other snippets + if(allTabSetIds[i] != tabSetId) + { + // Other tab sets may not have the same number of tabs + var tabCount = 1; + + while(document.getElementById(allTabSetIds[i] + "_tab" + tabCount) != null) + tabCount++; + + tabCount--; + + // If not grouped, skip it + if(tabCount > 1) + SetCurrentLanguage(allTabSetIds[i], language, tabCount); + } + + i++; + } +} + +// Sets the current language in the specified tab set +function SetCurrentLanguage(tabSetId, language, tabCount) +{ + var tabIndex = 1; + + while(tabIndex <= tabCount) + { + var tabTemp = document.getElementById(tabSetId + "_tab" + tabIndex); + + if(tabTemp != null && tabTemp.innerHTML.indexOf("'" + language + "'") != -1) + break; + + tabIndex++; + } + + if(tabIndex > tabCount) + { + // Select the first non-disabled tab + tabIndex = 1; + + if(document.getElementById(tabSetId + "_tab1").className == "codeSnippetContainerTabPhantom") + { + tabIndex++; + + while(tabIndex <= tabCount) + { + var tab = document.getElementById(tabSetId + "_tab" + tabIndex); + + if(tab.className != "codeSnippetContainerTabPhantom") + { + tab.className = "codeSnippetContainerTabActive"; + document.getElementById(tabSetId + "_code_Div" + j).style.display = "block"; + break; + } + + tabIndex++; + } + } + } + + SetActiveTab(tabSetId, tabIndex, tabCount); +} + +// Set the active tab within a tab set +function SetActiveTab(tabSetId, tabIndex, tabCount) +{ + var i = 1; + + while(i <= tabCount) + { + var tabTemp = document.getElementById(tabSetId + "_tab" + i); + + if (tabTemp != null) + { + if(tabTemp.className == "codeSnippetContainerTabActive") + tabTemp.className = "codeSnippetContainerTab"; + else + if(tabTemp.className == "codeSnippetContainerTabPhantom") + tabTemp.style.display = "none"; + + var codeTemp = document.getElementById(tabSetId + "_code_Div" + i); + + if(codeTemp.style.display != "none") + codeTemp.style.display = "none"; + } + + i++; + } + + // Phantom tabs are shown or hidden as needed + if(document.getElementById(tabSetId + "_tab" + tabIndex).className != "codeSnippetContainerTabPhantom") + document.getElementById(tabSetId + "_tab" + tabIndex).className = "codeSnippetContainerTabActive"; + else + document.getElementById(tabSetId + "_tab" + tabIndex).style.display = "block"; + + document.getElementById(tabSetId + "_code_Div" + tabIndex).style.display = "block"; +} + +// Copy the code from the active tab of the given tab set to the clipboard +function CopyToClipboard(tabSetId) +{ + var tabTemp, contentId; + var i = 1; + + if(typeof (Clipboard) == "function") + return; + + do + { + contentId = tabSetId + "_code_Div" + i; + tabTemp = document.getElementById(contentId); + + if(tabTemp != null && tabTemp.style.display != "none") + break; + + i++; + + } while(tabTemp != null); + + if(tabTemp == null) + return; + + if(window.clipboardData) + { + try + { + window.clipboardData.setData("Text", document.getElementById(contentId).innerText); + } + catch(e) + { + alert("Permission denied. Enable copying to the clipboard."); + } + } + else if(window.netscape) + { + try + { + netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect"); + + var clip = Components.classes["@mozilla.org/widget/clipboard;1"].createInstance( + Components.interfaces.nsIClipboard); + + if(!clip) + return; + + var trans = Components.classes["@mozilla.org/widget/transferable;1"].createInstance( + Components.interfaces.nsITransferable); + + if(!trans) + return; + + trans.addDataFlavor("text/unicode"); + + var str = new Object(); + var len = new Object(); + var str = Components.classes["@mozilla.org/supports-string;1"].createInstance( + Components.interfaces.nsISupportsString); + + var copytext = document.getElementById(contentId).textContent; + + str.data = copytext; + trans.setTransferData("text/unicode", str, copytext.length * 2); + + var clipid = Components.interfaces.nsIClipboard; + + clip.setData(trans, null, clipid.kGlobalClipboard); + } + catch(e) + { + alert("Permission denied. Enter \"about:config\" in the address bar and double-click the \"signed.applets.codebase_principal_support\" setting to enable copying to the clipboard."); + } + } +} + +// Expand or collapse a section +function SectionExpandCollapse(togglePrefix) +{ + var image = document.getElementById(togglePrefix + "Toggle"); + var section = document.getElementById(togglePrefix + "Section"); + + if(image != null && section != null) + if(section.style.display == "") + { + image.src = image.src.replace("SectionExpanded.png", "SectionCollapsed.png"); + section.style.display = "none"; + } + else + { + image.src = image.src.replace("SectionCollapsed.png", "SectionExpanded.png"); + section.style.display = ""; + } +} + +// Expand or collapse a section when it has the focus and Enter is hit +function SectionExpandCollapse_CheckKey(togglePrefix, eventArgs) +{ + if(eventArgs.keyCode == 13) + SectionExpandCollapse(togglePrefix); +} + +// Help 1 persistence object. This requires a hidden input element on the page with a class of "userDataStyle" +// defined in the style sheet that implements the user data binary behavior: +// +var Help1Globals = +{ + UserDataCache: function() + { + var userData = document.getElementById("userDataCache"); + + return userData; + }, + + Load: function(key) + { + var userData = this.UserDataCache(); + + userData.load("userDataSettings"); + + var value = userData.getAttribute(key); + + return value; + }, + + Save: function(key, value) + { + var userData = this.UserDataCache(); + userData.setAttribute(key, value); + userData.save("userDataSettings"); + } +}; diff --git a/SpriteLibrary/Doc/Help/scripts/clipboard.min.js b/SpriteLibrary/Doc/Help/scripts/clipboard.min.js new file mode 100644 index 0000000..580433f --- /dev/null +++ b/SpriteLibrary/Doc/Help/scripts/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v1.5.12 + * https://zenorocha.github.io/clipboard.js + * + * Licensed MIT © Zeno Rocha + */ +!function(t){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=t();else if("function"==typeof define&&define.amd)define([],t);else{var e;e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,e.Clipboard=t()}}(function(){var t,e,n;return function t(e,n,o){function i(a,c){if(!n[a]){if(!e[a]){var s="function"==typeof require&&require;if(!c&&s)return s(a,!0);if(r)return r(a,!0);var l=new Error("Cannot find module '"+a+"'");throw l.code="MODULE_NOT_FOUND",l}var u=n[a]={exports:{}};e[a][0].call(u.exports,function(t){var n=e[a][1][t];return i(n?n:t)},u,u.exports,t,e,n,o)}return n[a].exports}for(var r="function"==typeof require&&require,a=0;ao;o++)n[o].fn.apply(n[o].ctx,e);return this},off:function(t,e){var n=this.e||(this.e={}),o=n[t],i=[];if(o&&e)for(var r=0,a=o.length;a>r;r++)o[r].fn!==e&&o[r].fn._!==e&&i.push(o[r]);return i.length?n[t]=i:delete n[t],this}},e.exports=o},{}],8:[function(e,n,o){!function(i,r){if("function"==typeof t&&t.amd)t(["module","select"],r);else if("undefined"!=typeof o)r(n,e("select"));else{var a={exports:{}};r(a,i.select),i.clipboardAction=a.exports}}(this,function(t,e){"use strict";function n(t){return t&&t.__esModule?t:{"default":t}}function o(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}var i=n(e),r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol?"symbol":typeof t},a=function(){function t(t,e){for(var n=0;na?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=n.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return n.each(this,a,b)},map:function(a){return this.pushStack(n.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},n.extend=n.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||n.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(n.isPlainObject(c)||(b=n.isArray(c)))?(b?(b=!1,f=a&&n.isArray(a)?a:[]):f=a&&n.isPlainObject(a)?a:{},g[d]=n.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},n.extend({expando:"jQuery"+(m+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===n.type(a)},isArray:Array.isArray||function(a){return"array"===n.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==n.type(a)||a.nodeType||n.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(l.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&n.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(p,"ms-").replace(q,r)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=s(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:k&&!k.call("\ufeff\xa0")?function(a){return null==a?"":k.call(a)}:function(a){return null==a?"":(a+"").replace(o,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(s(Object(a))?n.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=s(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),n.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||n.guid++,e):void 0},now:function(){return+new Date},support:l}),n.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function s(a){var b=a.length,c=n.type(a);return"function"===c||n.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var t=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s="sizzle"+-new Date,t=a.document,u=0,v=0,w=eb(),x=eb(),y=eb(),z=function(a,b){return a===b&&(j=!0),0},A="undefined",B=1<<31,C={}.hasOwnProperty,D=[],E=D.pop,F=D.push,G=D.push,H=D.slice,I=D.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},J="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",K="[\\x20\\t\\r\\n\\f]",L="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",M=L.replace("w","w#"),N="\\["+K+"*("+L+")"+K+"*(?:([*^$|!~]?=)"+K+"*(?:(['\"])((?:\\\\.|[^\\\\])*?)\\3|("+M+")|)|)"+K+"*\\]",O=":("+L+")(?:\$((['\"])((?:\\\\.|[^\\\\])*?)\\3|((?:\\\\.|[^\\\\()[\\]]|"+N.replace(3,8)+")*)|.*)\$|)",P=new RegExp("^"+K+"+|((?:^|[^\\\\])(?:\\\\.)*)"+K+"+$","g"),Q=new RegExp("^"+K+"*,"+K+"*"),R=new RegExp("^"+K+"*([>+~]|"+K+")"+K+"*"),S=new RegExp("="+K+"*([^\\]'\"]*?)"+K+"*\\]","g"),T=new RegExp(O),U=new RegExp("^"+M+"$"),V={ID:new RegExp("^#("+L+")"),CLASS:new RegExp("^\\.("+L+")"),TAG:new RegExp("^("+L.replace("w","w*")+")"),ATTR:new RegExp("^"+N),PSEUDO:new RegExp("^"+O),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\$"+K+"*(even|odd|(([+-]|)(\\d*)n|)"+K+"*(?:([+-]|)"+K+"*(\\d+)|))"+K+"*\$|)","i"),bool:new RegExp("^(?:"+J+")$","i"),needsContext:new RegExp("^"+K+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\$"+K+"*((?:-\\d)?\\d*)"+K+"*\$|)(?=[^-]|$)","i")},W=/^(?:input|select|textarea|button)$/i,X=/^h\d$/i,Y=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,$=/[+~]/,_=/'|\\/g,ab=new RegExp("\\\\([\\da-f]{1,6}"+K+"?|("+K+")|.)","ig"),bb=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{G.apply(D=H.call(t.childNodes),t.childNodes),D[t.childNodes.length].nodeType}catch(cb){G={apply:D.length?function(a,b){F.apply(a,H.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function db(a,b,d,e){var f,g,h,i,j,m,p,q,u,v;if((b?b.ownerDocument||b:t)!==l&&k(b),b=b||l,d=d||[],!a||"string"!=typeof a)return d;if(1!==(i=b.nodeType)&&9!==i)return[];if(n&&!e){if(f=Z.exec(a))if(h=f[1]){if(9===i){if(g=b.getElementById(h),!g||!g.parentNode)return d;if(g.id===h)return d.push(g),d}else if(b.ownerDocument&&(g=b.ownerDocument.getElementById(h))&&r(b,g)&&g.id===h)return d.push(g),d}else{if(f[2])return G.apply(d,b.getElementsByTagName(a)),d;if((h=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return G.apply(d,b.getElementsByClassName(h)),d}if(c.qsa&&(!o||!o.test(a))){if(q=p=s,u=b,v=9===i&&a,1===i&&"object"!==b.nodeName.toLowerCase()){m=ob(a),(p=b.getAttribute("id"))?q=p.replace(_,"\\$&"):b.setAttribute("id",q),q="[id='"+q+"'] ",j=m.length;while(j--)m[j]=q+pb(m[j]);u=$.test(a)&&mb(b.parentNode)||b,v=m.join(",")}if(v)try{return G.apply(d,u.querySelectorAll(v)),d}catch(w){}finally{p||b.removeAttribute("id")}}}return xb(a.replace(P,"$1"),b,d,e)}function eb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function fb(a){return a[s]=!0,a}function gb(a){var b=l.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function hb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function ib(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||B)-(~a.sourceIndex||B);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function jb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function kb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function lb(a){return fb(function(b){return b=+b,fb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function mb(a){return a&&typeof a.getElementsByTagName!==A&&a}c=db.support={},f=db.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},k=db.setDocument=function(a){var b,e=a?a.ownerDocument||a:t,g=e.defaultView;return e!==l&&9===e.nodeType&&e.documentElement?(l=e,m=e.documentElement,n=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){k()},!1):g.attachEvent&&g.attachEvent("onunload",function(){k()})),c.attributes=gb(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=gb(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Y.test(e.getElementsByClassName)&&gb(function(a){return a.innerHTML="
",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=gb(function(a){return m.appendChild(a).id=s,!e.getElementsByName||!e.getElementsByName(s).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==A&&n){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(ab,bb);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(ab,bb);return function(a){var c=typeof a.getAttributeNode!==A&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==A?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==A&&n?b.getElementsByClassName(a):void 0},p=[],o=[],(c.qsa=Y.test(e.querySelectorAll))&&(gb(function(a){a.innerHTML="",a.querySelectorAll("[t^='']").length&&o.push("[*^$]="+K+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||o.push("\\["+K+"*(?:value|"+J+")"),a.querySelectorAll(":checked").length||o.push(":checked")}),gb(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&o.push("name"+K+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||o.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),o.push(",.*:")})),(c.matchesSelector=Y.test(q=m.webkitMatchesSelector||m.mozMatchesSelector||m.oMatchesSelector||m.msMatchesSelector))&&gb(function(a){c.disconnectedMatch=q.call(a,"div"),q.call(a,"[s!='']:x"),p.push("!=",O)}),o=o.length&&new RegExp(o.join("|")),p=p.length&&new RegExp(p.join("|")),b=Y.test(m.compareDocumentPosition),r=b||Y.test(m.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},z=b?function(a,b){if(a===b)return j=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===t&&r(t,a)?-1:b===e||b.ownerDocument===t&&r(t,b)?1:i?I.call(i,a)-I.call(i,b):0:4&d?-1:1)}:function(a,b){if(a===b)return j=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],k=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:i?I.call(i,a)-I.call(i,b):0;if(f===g)return ib(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)k.unshift(c);while(h[d]===k[d])d++;return d?ib(h[d],k[d]):h[d]===t?-1:k[d]===t?1:0},e):l},db.matches=function(a,b){return db(a,null,null,b)},db.matchesSelector=function(a,b){if((a.ownerDocument||a)!==l&&k(a),b=b.replace(S,"='$1']"),!(!c.matchesSelector||!n||p&&p.test(b)||o&&o.test(b)))try{var d=q.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return db(b,l,null,[a]).length>0},db.contains=function(a,b){return(a.ownerDocument||a)!==l&&k(a),r(a,b)},db.attr=function(a,b){(a.ownerDocument||a)!==l&&k(a);var e=d.attrHandle[b.toLowerCase()],f=e&&C.call(d.attrHandle,b.toLowerCase())?e(a,b,!n):void 0;return void 0!==f?f:c.attributes||!n?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},db.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},db.uniqueSort=function(a){var b,d=[],e=0,f=0;if(j=!c.detectDuplicates,i=!c.sortStable&&a.slice(0),a.sort(z),j){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return i=null,a},e=db.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=db.selectors={cacheLength:50,createPseudo:fb,match:V,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(ab,bb),a[3]=(a[4]||a[5]||"").replace(ab,bb),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||db.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&db.error(a[0]),a},PSEUDO:function(a){var b,c=!a[5]&&a[2];return V.CHILD.test(a[0])?null:(a[3]&&void 0!==a[4]?a[2]=a[4]:c&&T.test(c)&&(b=ob(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(ab,bb).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=w[a+" "];return b||(b=new RegExp("(^|"+K+")"+a+"("+K+"|$)"))&&w(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==A&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=db.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),t=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&t){k=q[s]||(q[s]={}),j=k[a]||[],n=j[0]===u&&j[1],m=j[0]===u&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[u,n,m];break}}else if(t&&(j=(b[s]||(b[s]={}))[a])&&j[0]===u)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(t&&((l[s]||(l[s]={}))[a]=[u,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||db.error("unsupported pseudo: "+a);return e[s]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?fb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=I.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:fb(function(a){var b=[],c=[],d=g(a.replace(P,"$1"));return d[s]?fb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:fb(function(a){return function(b){return db(a,b).length>0}}),contains:fb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:fb(function(a){return U.test(a||"")||db.error("unsupported lang: "+a),a=a.replace(ab,bb).toLowerCase(),function(b){var c;do if(c=n?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===m},focus:function(a){return a===l.activeElement&&(!l.hasFocus||l.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return X.test(a.nodeName)},input:function(a){return W.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:lb(function(){return[0]}),last:lb(function(a,b){return[b-1]}),eq:lb(function(a,b,c){return[0>c?c+b:c]}),even:lb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:lb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:lb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:lb(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function qb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=v++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[u,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[s]||(b[s]={}),(h=i[d])&&h[0]===u&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function rb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function sb(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function tb(a,b,c,d,e,f){return d&&!d[s]&&(d=tb(d)),e&&!e[s]&&(e=tb(e,f)),fb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||wb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:sb(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=sb(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?I.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=sb(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):G.apply(g,r)})}function ub(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],i=g||d.relative[" "],j=g?1:0,k=qb(function(a){return a===b},i,!0),l=qb(function(a){return I.call(b,a)>-1},i,!0),m=[function(a,c,d){return!g&&(d||c!==h)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>j;j++)if(c=d.relative[a[j].type])m=[qb(rb(m),c)];else{if(c=d.filter[a[j].type].apply(null,a[j].matches),c[s]){for(e=++j;f>e;e++)if(d.relative[a[e].type])break;return tb(j>1&&rb(m),j>1&&pb(a.slice(0,j-1).concat({value:" "===a[j-2].type?"*":""})).replace(P,"$1"),c,e>j&&ub(a.slice(j,e)),f>e&&ub(a=a.slice(e)),f>e&&pb(a))}m.push(c)}return rb(m)}function vb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,i,j,k){var m,n,o,p=0,q="0",r=f&&[],s=[],t=h,v=f||e&&d.find.TAG("*",k),w=u+=null==t?1:Math.random()||.1,x=v.length;for(k&&(h=g!==l&&g);q!==x&&null!=(m=v[q]);q++){if(e&&m){n=0;while(o=a[n++])if(o(m,g,i)){j.push(m);break}k&&(u=w)}c&&((m=!o&&m)&&p--,f&&r.push(m))}if(p+=q,c&&q!==p){n=0;while(o=b[n++])o(r,s,g,i);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=E.call(j));s=sb(s)}G.apply(j,s),k&&!f&&s.length>0&&p+b.length>1&&db.uniqueSort(j)}return k&&(u=w,h=t),r};return c?fb(f):f}g=db.compile=function(a,b){var c,d=[],e=[],f=y[a+" "];if(!f){b||(b=ob(a)),c=b.length;while(c--)f=ub(b[c]),f[s]?d.push(f):e.push(f);f=y(a,vb(e,d))}return f};function wb(a,b,c){for(var d=0,e=b.length;e>d;d++)db(a,b[d],c);return c}function xb(a,b,e,f){var h,i,j,k,l,m=ob(a);if(!f&&1===m.length){if(i=m[0]=m[0].slice(0),i.length>2&&"ID"===(j=i[0]).type&&c.getById&&9===b.nodeType&&n&&d.relative[i[1].type]){if(b=(d.find.ID(j.matches[0].replace(ab,bb),b)||[])[0],!b)return e;a=a.slice(i.shift().value.length)}h=V.needsContext.test(a)?0:i.length;while(h--){if(j=i[h],d.relative[k=j.type])break;if((l=d.find[k])&&(f=l(j.matches[0].replace(ab,bb),$.test(i[0].type)&&mb(b.parentNode)||b))){if(i.splice(h,1),a=f.length&&pb(i),!a)return G.apply(e,f),e;break}}}return g(a,m)(f,b,!n,e,$.test(a)&&mb(b.parentNode)||b),e}return c.sortStable=s.split("").sort(z).join("")===s,c.detectDuplicates=!!j,k(),c.sortDetached=gb(function(a){return 1&a.compareDocumentPosition(l.createElement("div"))}),gb(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||hb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&gb(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||hb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),gb(function(a){return null==a.getAttribute("disabled")})||hb(J,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),db}(a);n.find=t,n.expr=t.selectors,n.expr[":"]=n.expr.pseudos,n.unique=t.uniqueSort,n.text=t.getText,n.isXMLDoc=t.isXML,n.contains=t.contains;var u=n.expr.match.needsContext,v=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,w=/^.[^:#\[\.,]*$/;function x(a,b,c){if(n.isFunction(b))return n.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return n.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(w.test(b))return n.filter(b,a,c);b=n.filter(b,a)}return n.grep(a,function(a){return n.inArray(a,b)>=0!==c})}n.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?n.find.matchesSelector(d,a)?[d]:[]:n.find.matches(a,n.grep(b,function(a){return 1===a.nodeType}))},n.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(n(a).filter(function(){for(b=0;e>b;b++)if(n.contains(d[b],this))return!0}));for(b=0;e>b;b++)n.find(a,d[b],c);return c=this.pushStack(e>1?n.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(x(this,a||[],!1))},not:function(a){return this.pushStack(x(this,a||[],!0))},is:function(a){return!!x(this,"string"==typeof a&&u.test(a)?n(a):a||[],!1).length}});var y,z=a.document,A=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,B=n.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:A.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||y).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof n?b[0]:b,n.merge(this,n.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:z,!0)),v.test(c[1])&&n.isPlainObject(b))for(c in b)n.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=z.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return y.find(a);this.length=1,this[0]=d}return this.context=z,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):n.isFunction(a)?"undefined"!=typeof y.ready?y.ready(a):a(n):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),n.makeArray(a,this))};B.prototype=n.fn,y=n(z);var C=/^(?:parents|prev(?:Until|All))/,D={children:!0,contents:!0,next:!0,prev:!0};n.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!n(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),n.fn.extend({has:function(a){var b,c=n(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(n.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=u.test(a)||"string"!=typeof a?n(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&n.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?n.unique(f):f)},index:function(a){return a?"string"==typeof a?n.inArray(this[0],n(a)):n.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(n.unique(n.merge(this.get(),n(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function E(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}n.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return n.dir(a,"parentNode")},parentsUntil:function(a,b,c){return n.dir(a,"parentNode",c)},next:function(a){return E(a,"nextSibling")},prev:function(a){return E(a,"previousSibling")},nextAll:function(a){return n.dir(a,"nextSibling")},prevAll:function(a){return n.dir(a,"previousSibling")},nextUntil:function(a,b,c){return n.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return n.dir(a,"previousSibling",c)},siblings:function(a){return n.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return n.sibling(a.firstChild)},contents:function(a){return n.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:n.merge([],a.childNodes)}},function(a,b){n.fn[a]=function(c,d){var e=n.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=n.filter(d,e)),this.length>1&&(D[a]||(e=n.unique(e)),C.test(a)&&(e=e.reverse())),this.pushStack(e)}});var F=/\S+/g,G={};function H(a){var b=G[a]={};return n.each(a.match(F)||[],function(a,c){b[c]=!0}),b}n.Callbacks=function(a){a="string"==typeof a?G[a]||H(a):n.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){n.each(b,function(b,c){var d=n.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&n.each(arguments,function(a,c){var d;while((d=n.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?n.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},n.extend({Deferred:function(a){var b=[["resolve","done",n.Callbacks("once memory"),"resolved"],["reject","fail",n.Callbacks("once memory"),"rejected"],["notify","progress",n.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return n.Deferred(function(c){n.each(b,function(b,f){var g=n.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&n.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?n.extend(a,d):d}},e={};return d.pipe=d.then,n.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&n.isFunction(a.promise)?e:0,g=1===f?a:n.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&n.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var I;n.fn.ready=function(a){return n.ready.promise().done(a),this},n.extend({isReady:!1,readyWait:1,holdReady:function(a){a?n.readyWait++:n.ready(!0)},ready:function(a){if(a===!0?!--n.readyWait:!n.isReady){if(!z.body)return setTimeout(n.ready);n.isReady=!0,a!==!0&&--n.readyWait>0||(I.resolveWith(z,[n]),n.fn.trigger&&n(z).trigger("ready").off("ready"))}}});function J(){z.addEventListener?(z.removeEventListener("DOMContentLoaded",K,!1),a.removeEventListener("load",K,!1)):(z.detachEvent("onreadystatechange",K),a.detachEvent("onload",K))}function K(){(z.addEventListener||"load"===event.type||"complete"===z.readyState)&&(J(),n.ready())}n.ready.promise=function(b){if(!I)if(I=n.Deferred(),"complete"===z.readyState)setTimeout(n.ready);else if(z.addEventListener)z.addEventListener("DOMContentLoaded",K,!1),a.addEventListener("load",K,!1);else{z.attachEvent("onreadystatechange",K),a.attachEvent("onload",K);var c=!1;try{c=null==a.frameElement&&z.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!n.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}J(),n.ready()}}()}return I.promise(b)};var L="undefined",M;for(M in n(l))break;l.ownLast="0"!==M,l.inlineBlockNeedsLayout=!1,n(function(){var a,b,c=z.getElementsByTagName("body")[0];c&&(a=z.createElement("div"),a.style.cssText="border:0;width:0;height:0;position:absolute;top:0;left:-9999px;margin-top:1px",b=z.createElement("div"),c.appendChild(a).appendChild(b),typeof b.style.zoom!==L&&(b.style.cssText="border:0;margin:0;width:1px;padding:1px;display:inline;zoom:1",(l.inlineBlockNeedsLayout=3===b.offsetWidth)&&(c.style.zoom=1)),c.removeChild(a),a=b=null)}),function(){var a=z.createElement("div");if(null==l.deleteExpando){l.deleteExpando=!0;try{delete a.test}catch(b){l.deleteExpando=!1}}a=null}(),n.acceptData=function(a){var b=n.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var N=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,O=/([A-Z])/g;function P(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(O,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:N.test(c)?n.parseJSON(c):c}catch(e){}n.data(a,b,c)}else c=void 0}return c}function Q(a){var b;for(b in a)if(("data"!==b||!n.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function R(a,b,d,e){if(n.acceptData(a)){var f,g,h=n.expando,i=a.nodeType,j=i?n.cache:a,k=i?a[h]:a[h]&&h;if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||n.guid++:h),j[k]||(j[k]=i?{}:{toJSON:n.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=n.extend(j[k],b):j[k].data=n.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[n.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[n.camelCase(b)])):f=g,f +}}function S(a,b,c){if(n.acceptData(a)){var d,e,f=a.nodeType,g=f?n.cache:a,h=f?a[n.expando]:n.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){n.isArray(b)?b=b.concat(n.map(b,n.camelCase)):b in d?b=[b]:(b=n.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!Q(d):!n.isEmptyObject(d))return}(c||(delete g[h].data,Q(g[h])))&&(f?n.cleanData([a],!0):l.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}n.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?n.cache[a[n.expando]]:a[n.expando],!!a&&!Q(a)},data:function(a,b,c){return R(a,b,c)},removeData:function(a,b){return S(a,b)},_data:function(a,b,c){return R(a,b,c,!0)},_removeData:function(a,b){return S(a,b,!0)}}),n.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=n.data(f),1===f.nodeType&&!n._data(f,"parsedAttrs"))){c=g.length;while(c--)d=g[c].name,0===d.indexOf("data-")&&(d=n.camelCase(d.slice(5)),P(f,d,e[d]));n._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){n.data(this,a)}):arguments.length>1?this.each(function(){n.data(this,a,b)}):f?P(f,a,n.data(f,a)):void 0},removeData:function(a){return this.each(function(){n.removeData(this,a)})}}),n.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=n._data(a,b),c&&(!d||n.isArray(c)?d=n._data(a,b,n.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=n.queue(a,b),d=c.length,e=c.shift(),f=n._queueHooks(a,b),g=function(){n.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return n._data(a,c)||n._data(a,c,{empty:n.Callbacks("once memory").add(function(){n._removeData(a,b+"queue"),n._removeData(a,c)})})}}),n.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},X=/^(?:checkbox|radio)$/i;!function(){var a=z.createDocumentFragment(),b=z.createElement("div"),c=z.createElement("input");if(b.setAttribute("className","t"),b.innerHTML="
a",l.leadingWhitespace=3===b.firstChild.nodeType,l.tbody=!b.getElementsByTagName("tbody").length,l.htmlSerialize=!!b.getElementsByTagName("link").length,l.html5Clone="<:nav>"!==z.createElement("nav").cloneNode(!0).outerHTML,c.type="checkbox",c.checked=!0,a.appendChild(c),l.appendChecked=c.checked,b.innerHTML="x",l.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,a.appendChild(b),b.innerHTML="",l.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,l.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){l.noCloneEvent=!1}),b.cloneNode(!0).click()),null==l.deleteExpando){l.deleteExpando=!0;try{delete b.test}catch(d){l.deleteExpando=!1}}a=b=c=null}(),function(){var b,c,d=z.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(l[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),l[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var Y=/^(?:input|select|textarea)$/i,Z=/^key/,$=/^(?:mouse|contextmenu)|click/,_=/^(?:focusinfocus|focusoutblur)$/,ab=/^([^.]*)(?:\.(.+)|)$/;function bb(){return!0}function cb(){return!1}function db(){try{return z.activeElement}catch(a){}}n.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,o,p,q,r=n._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=n.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof n===L||a&&n.event.triggered===a.type?void 0:n.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(F)||[""],h=b.length;while(h--)f=ab.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=n.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=n.event.special[o]||{},l=n.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&n.expr.match.needsContext.test(e),namespace:p.join(".")},i),(m=g[o])||(m=g[o]=[],m.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,l):m.push(l),n.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,o,p,q,r=n.hasData(a)&&n._data(a);if(r&&(k=r.events)){b=(b||"").match(F)||[""],j=b.length;while(j--)if(h=ab.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=n.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,m=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=m.length;while(f--)g=m[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(m.splice(f,1),g.selector&&m.delegateCount--,l.remove&&l.remove.call(a,g));i&&!m.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||n.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)n.event.remove(a,o+b[j],c,d,!0);n.isEmptyObject(k)&&(delete r.handle,n._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,m,o=[d||z],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||z,3!==d.nodeType&&8!==d.nodeType&&!_.test(p+n.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[n.expando]?b:new n.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:n.makeArray(c,[b]),k=n.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!n.isWindow(d)){for(i=k.delegateType||p,_.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||z)&&o.push(l.defaultView||l.parentWindow||a)}m=0;while((h=o[m++])&&!b.isPropagationStopped())b.type=m>1?i:k.bindType||p,f=(n._data(h,"events")||{})[b.type]&&n._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&n.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&n.acceptData(d)&&g&&d[p]&&!n.isWindow(d)){l=d[g],l&&(d[g]=null),n.event.triggered=p;try{d[p]()}catch(r){}n.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=n.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(n._data(this,"events")||{})[a.type]||[],k=n.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=n.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((n.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?n(c,this).index(i)>=0:n.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),ib=/^\s+/,jb=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,kb=/<([\w:]+)/,lb=/\s*$/g,sb={option:[1,""],legend:[1,"
","
"],area:[1,"",""],param:[1,""],thead:[1,"","
"],tr:[2,"","
"],col:[2,"","
"],td:[3,"","
"],_default:l.htmlSerialize?[0,"",""]:[1,"X
","
"]},tb=eb(z),ub=tb.appendChild(z.createElement("div"));sb.optgroup=sb.option,sb.tbody=sb.tfoot=sb.colgroup=sb.caption=sb.thead,sb.th=sb.td;function vb(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==L?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==L?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||n.nodeName(d,b)?f.push(d):n.merge(f,vb(d,b));return void 0===b||b&&n.nodeName(a,b)?n.merge([a],f):f}function wb(a){X.test(a.type)&&(a.defaultChecked=a.checked)}function xb(a,b){return n.nodeName(a,"table")&&n.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function yb(a){return a.type=(null!==n.find.attr(a,"type"))+"/"+a.type,a}function zb(a){var b=qb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Ab(a,b){for(var c,d=0;null!=(c=a[d]);d++)n._data(c,"globalEval",!b||n._data(b[d],"globalEval"))}function Bb(a,b){if(1===b.nodeType&&n.hasData(a)){var c,d,e,f=n._data(a),g=n._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)n.event.add(b,c,h[c][d])}g.data&&(g.data=n.extend({},g.data))}}function Cb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!l.noCloneEvent&&b[n.expando]){e=n._data(b);for(d in e.events)n.removeEvent(b,d,e.handle);b.removeAttribute(n.expando)}"script"===c&&b.text!==a.text?(yb(b).text=a.text,zb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),l.html5Clone&&a.innerHTML&&!n.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&X.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}n.extend({clone:function(a,b,c){var d,e,f,g,h,i=n.contains(a.ownerDocument,a);if(l.html5Clone||n.isXMLDoc(a)||!hb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(ub.innerHTML=a.outerHTML,ub.removeChild(f=ub.firstChild)),!(l.noCloneEvent&&l.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||n.isXMLDoc(a)))for(d=vb(f),h=vb(a),g=0;null!=(e=h[g]);++g)d[g]&&Cb(e,d[g]);if(b)if(c)for(h=h||vb(a),d=d||vb(f),g=0;null!=(e=h[g]);g++)Bb(e,d[g]);else Bb(a,f);return d=vb(f,"script"),d.length>0&&Ab(d,!i&&vb(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,k,m=a.length,o=eb(b),p=[],q=0;m>q;q++)if(f=a[q],f||0===f)if("object"===n.type(f))n.merge(p,f.nodeType?[f]:f);else if(mb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(kb.exec(f)||["",""])[1].toLowerCase(),k=sb[i]||sb._default,h.innerHTML=k[1]+f.replace(jb,"<$1>")+k[2],e=k[0];while(e--)h=h.lastChild;if(!l.leadingWhitespace&&ib.test(f)&&p.push(b.createTextNode(ib.exec(f)[0])),!l.tbody){f="table"!==i||lb.test(f)?""!==k[1]||lb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)n.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}n.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),l.appendChecked||n.grep(vb(p,"input"),wb),q=0;while(f=p[q++])if((!d||-1===n.inArray(f,d))&&(g=n.contains(f.ownerDocument,f),h=vb(o.appendChild(f),"script"),g&&Ab(h),c)){e=0;while(f=h[e++])pb.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=n.expando,j=n.cache,k=l.deleteExpando,m=n.event.special;null!=(d=a[h]);h++)if((b||n.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)m[e]?n.event.remove(d,e):n.removeEvent(d,e,g.handle);j[f]&&(delete j[f],k?delete d[i]:typeof d.removeAttribute!==L?d.removeAttribute(i):d[i]=null,c.push(f))}}}),n.fn.extend({text:function(a){return W(this,function(a){return void 0===a?n.text(this):this.empty().append((this[0]&&this[0].ownerDocument||z).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=xb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=xb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?n.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||n.cleanData(vb(c)),c.parentNode&&(b&&n.contains(c.ownerDocument,c)&&Ab(vb(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&n.cleanData(vb(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&n.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return n.clone(this,a,b)})},html:function(a){return W(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(gb,""):void 0;if(!("string"!=typeof a||nb.test(a)||!l.htmlSerialize&&hb.test(a)||!l.leadingWhitespace&&ib.test(a)||sb[(kb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(jb,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(n.cleanData(vb(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,n.cleanData(vb(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,k=this.length,m=this,o=k-1,p=a[0],q=n.isFunction(p);if(q||k>1&&"string"==typeof p&&!l.checkClone&&ob.test(p))return this.each(function(c){var d=m.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(k&&(i=n.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=n.map(vb(i,"script"),yb),f=g.length;k>j;j++)d=i,j!==o&&(d=n.clone(d,!0,!0),f&&n.merge(g,vb(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,n.map(g,zb),j=0;f>j;j++)d=g[j],pb.test(d.type||"")&&!n._data(d,"globalEval")&&n.contains(h,d)&&(d.src?n._evalUrl&&n._evalUrl(d.src):n.globalEval((d.text||d.textContent||d.innerHTML||"").replace(rb,"")));i=c=null}return this}}),n.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){n.fn[a]=function(a){for(var c,d=0,e=[],g=n(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),n(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Db,Eb={};function Fb(b,c){var d=n(c.createElement(b)).appendTo(c.body),e=a.getDefaultComputedStyle?a.getDefaultComputedStyle(d[0]).display:n.css(d[0],"display");return d.detach(),e}function Gb(a){var b=z,c=Eb[a];return c||(c=Fb(a,b),"none"!==c&&c||(Db=(Db||n("")).appendTo(b.documentElement),b=(Db[0].contentWindow||Db[0].contentDocument).document,b.write(),b.close(),c=Fb(a,b),Db.detach()),Eb[a]=c),c}!function(){var a,b,c=z.createElement("div"),d="-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;display:block;padding:0;margin:0;border:0";c.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",a=c.getElementsByTagName("a")[0],a.style.cssText="float:left;opacity:.5",l.opacity=/^0.5/.test(a.style.opacity),l.cssFloat=!!a.style.cssFloat,c.style.backgroundClip="content-box",c.cloneNode(!0).style.backgroundClip="",l.clearCloneStyle="content-box"===c.style.backgroundClip,a=c=null,l.shrinkWrapBlocks=function(){var a,c,e,f;if(null==b){if(a=z.getElementsByTagName("body")[0],!a)return;f="border:0;width:0;height:0;position:absolute;top:0;left:-9999px",c=z.createElement("div"),e=z.createElement("div"),a.appendChild(c).appendChild(e),b=!1,typeof e.style.zoom!==L&&(e.style.cssText=d+";width:1px;padding:1px;zoom:1",e.innerHTML="<div></div>",e.firstChild.style.width="5px",b=3!==e.offsetWidth),a.removeChild(c),a=c=e=null}return b}}();var Hb=/^margin/,Ib=new RegExp("^("+T+")(?!px)[a-z%]+$","i"),Jb,Kb,Lb=/^(top|right|bottom|left)$/;a.getComputedStyle?(Jb=function(a){return a.ownerDocument.defaultView.getComputedStyle(a,null)},Kb=function(a,b,c){var d,e,f,g,h=a.style;return c=c||Jb(a),g=c?c.getPropertyValue(b)||c[b]:void 0,c&&(""!==g||n.contains(a.ownerDocument,a)||(g=n.style(a,b)),Ib.test(g)&&Hb.test(b)&&(d=h.width,e=h.minWidth,f=h.maxWidth,h.minWidth=h.maxWidth=h.width=g,g=c.width,h.width=d,h.minWidth=e,h.maxWidth=f)),void 0===g?g:g+""}):z.documentElement.currentStyle&&(Jb=function(a){return a.currentStyle},Kb=function(a,b,c){var d,e,f,g,h=a.style;return c=c||Jb(a),g=c?c[b]:void 0,null==g&&h&&h[b]&&(g=h[b]),Ib.test(g)&&!Lb.test(b)&&(d=h.left,e=a.runtimeStyle,f=e&&e.left,f&&(e.left=a.currentStyle.left),h.left="fontSize"===b?"1em":g,g=h.pixelLeft+"px",h.left=d,f&&(e.left=f)),void 0===g?g:g+""||"auto"});function Mb(a,b){return{get:function(){var c=a();if(null!=c)return c?void delete this.get:(this.get=b).apply(this,arguments)}}}!function(){var b,c,d,e,f,g,h=z.createElement("div"),i="border:0;width:0;height:0;position:absolute;top:0;left:-9999px",j="-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;display:block;padding:0;margin:0;border:0";h.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",b=h.getElementsByTagName("a")[0],b.style.cssText="float:left;opacity:.5",l.opacity=/^0.5/.test(b.style.opacity),l.cssFloat=!!b.style.cssFloat,h.style.backgroundClip="content-box",h.cloneNode(!0).style.backgroundClip="",l.clearCloneStyle="content-box"===h.style.backgroundClip,b=h=null,n.extend(l,{reliableHiddenOffsets:function(){if(null!=c)return c;var a,b,d,e=z.createElement("div"),f=z.getElementsByTagName("body")[0];if(f)return e.setAttribute("className","t"),e.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",a=z.createElement("div"),a.style.cssText=i,f.appendChild(a).appendChild(e),e.innerHTML="<table><tr><td></td><td>t</td></tr></table>",b=e.getElementsByTagName("td"),b[0].style.cssText="padding:0;margin:0;border:0;display:none",d=0===b[0].offsetHeight,b[0].style.display="",b[1].style.display="none",c=d&&0===b[0].offsetHeight,f.removeChild(a),e=f=null,c},boxSizing:function(){return null==d&&k(),d},boxSizingReliable:function(){return null==e&&k(),e},pixelPosition:function(){return null==f&&k(),f},reliableMarginRight:function(){var b,c,d,e;if(null==g&&a.getComputedStyle){if(b=z.getElementsByTagName("body")[0],!b)return;c=z.createElement("div"),d=z.createElement("div"),c.style.cssText=i,b.appendChild(c).appendChild(d),e=d.appendChild(z.createElement("div")),e.style.cssText=d.style.cssText=j,e.style.marginRight=e.style.width="0",d.style.width="1px",g=!parseFloat((a.getComputedStyle(e,null)||{}).marginRight),b.removeChild(c)}return g}});function k(){var b,c,h=z.getElementsByTagName("body")[0];h&&(b=z.createElement("div"),c=z.createElement("div"),b.style.cssText=i,h.appendChild(b).appendChild(c),c.style.cssText="-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;position:absolute;display:block;padding:1px;border:1px;width:4px;margin-top:1%;top:1%",n.swap(h,null!=h.style.zoom?{zoom:1}:{},function(){d=4===c.offsetWidth}),e=!0,f=!1,g=!0,a.getComputedStyle&&(f="1%"!==(a.getComputedStyle(c,null)||{}).top,e="4px"===(a.getComputedStyle(c,null)||{width:"4px"}).width),h.removeChild(b),c=h=null)}}(),n.swap=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f in b)a.style[f]=g[f];return e};var Nb=/alpha$[^)]*$/i,Ob=/opacity\s*=\s*([^)]*)/,Pb=/^(none|table(?!-c[ea]).+)/,Qb=new RegExp("^("+T+")(.*)$","i"),Rb=new RegExp("^([+-])=("+T+")","i"),Sb={position:"absolute",visibility:"hidden",display:"block"},Tb={letterSpacing:0,fontWeight:400},Ub=["Webkit","O","Moz","ms"];function Vb(a,b){if(b in a)return b;var c=b.charAt(0).toUpperCase()+b.slice(1),d=b,e=Ub.length;while(e--)if(b=Ub[e]+c,b in a)return b;return d}function Wb(a,b){for(var c,d,e,f=[],g=0,h=a.length;h>g;g++)d=a[g],d.style&&(f[g]=n._data(d,"olddisplay"),c=d.style.display,b?(f[g]||"none"!==c||(d.style.display=""),""===d.style.display&&V(d)&&(f[g]=n._data(d,"olddisplay",Gb(d.nodeName)))):f[g]||(e=V(d),(c&&"none"!==c||!e)&&n._data(d,"olddisplay",e?c:n.css(d,"display"))));for(g=0;h>g;g++)d=a[g],d.style&&(b&&"none"!==d.style.display&&""!==d.style.display||(d.style.display=b?f[g]||"":"none"));return a}function Xb(a,b,c){var d=Qb.exec(b);return d?Math.max(0,d[1]-(c||0))+(d[2]||"px"):b}function Yb(a,b,c,d,e){for(var f=c===(d?"border":"content")?4:"width"===b?1:0,g=0;4>f;f+=2)"margin"===c&&(g+=n.css(a,c+U[f],!0,e)),d?("content"===c&&(g-=n.css(a,"padding"+U[f],!0,e)),"margin"!==c&&(g-=n.css(a,"border"+U[f]+"Width",!0,e))):(g+=n.css(a,"padding"+U[f],!0,e),"padding"!==c&&(g+=n.css(a,"border"+U[f]+"Width",!0,e)));return g}function Zb(a,b,c){var d=!0,e="width"===b?a.offsetWidth:a.offsetHeight,f=Jb(a),g=l.boxSizing()&&"border-box"===n.css(a,"boxSizing",!1,f);if(0>=e||null==e){if(e=Kb(a,b,f),(0>e||null==e)&&(e=a.style[b]),Ib.test(e))return e;d=g&&(l.boxSizingReliable()||e===a.style[b]),e=parseFloat(e)||0}return e+Yb(a,b,c||(g?"border":"content"),d,f)+"px"}n.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=Kb(a,"opacity");return""===c?"1":c}}}},cssNumber:{columnCount:!0,fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":l.cssFloat?"cssFloat":"styleFloat"},style:function(a,b,c,d){if(a&&3!==a.nodeType&&8!==a.nodeType&&a.style){var e,f,g,h=n.camelCase(b),i=a.style;if(b=n.cssProps[h]||(n.cssProps[h]=Vb(i,h)),g=n.cssHooks[b]||n.cssHooks[h],void 0===c)return g&&"get"in g&&void 0!==(e=g.get(a,!1,d))?e:i[b];if(f=typeof c,"string"===f&&(e=Rb.exec(c))&&(c=(e[1]+1)*e[2]+parseFloat(n.css(a,b)),f="number"),null!=c&&c===c&&("number"!==f||n.cssNumber[h]||(c+="px"),l.clearCloneStyle||""!==c||0!==b.indexOf("background")||(i[b]="inherit"),!(g&&"set"in g&&void 0===(c=g.set(a,c,d)))))try{i[b]="",i[b]=c}catch(j){}}},css:function(a,b,c,d){var e,f,g,h=n.camelCase(b);return b=n.cssProps[h]||(n.cssProps[h]=Vb(a.style,h)),g=n.cssHooks[b]||n.cssHooks[h],g&&"get"in g&&(f=g.get(a,!0,c)),void 0===f&&(f=Kb(a,b,d)),"normal"===f&&b in Tb&&(f=Tb[b]),""===c||c?(e=parseFloat(f),c===!0||n.isNumeric(e)?e||0:f):f}}),n.each(["height","width"],function(a,b){n.cssHooks[b]={get:function(a,c,d){return c?0===a.offsetWidth&&Pb.test(n.css(a,"display"))?n.swap(a,Sb,function(){return Zb(a,b,d)}):Zb(a,b,d):void 0},set:function(a,c,d){var e=d&&Jb(a);return Xb(a,c,d?Yb(a,b,d,l.boxSizing()&&"border-box"===n.css(a,"boxSizing",!1,e),e):0)}}}),l.opacity||(n.cssHooks.opacity={get:function(a,b){return Ob.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?.01*parseFloat(RegExp.$1)+"":b?"1":""},set:function(a,b){var c=a.style,d=a.currentStyle,e=n.isNumeric(b)?"alpha(opacity="+100*b+")":"",f=d&&d.filter||c.filter||"";c.zoom=1,(b>=1||""===b)&&""===n.trim(f.replace(Nb,""))&&c.removeAttribute&&(c.removeAttribute("filter"),""===b||d&&!d.filter)||(c.filter=Nb.test(f)?f.replace(Nb,e):f+" "+e)}}),n.cssHooks.marginRight=Mb(l.reliableMarginRight,function(a,b){return b?n.swap(a,{display:"inline-block"},Kb,[a,"marginRight"]):void 0}),n.each({margin:"",padding:"",border:"Width"},function(a,b){n.cssHooks[a+b]={expand:function(c){for(var d=0,e={},f="string"==typeof c?c.split(" "):[c];4>d;d++)e[a+U[d]+b]=f[d]||f[d-2]||f[0];return e}},Hb.test(a)||(n.cssHooks[a+b].set=Xb)}),n.fn.extend({css:function(a,b){return W(this,function(a,b,c){var d,e,f={},g=0;if(n.isArray(b)){for(d=Jb(a),e=b.length;e>g;g++)f[b[g]]=n.css(a,b[g],!1,d);return f}return void 0!==c?n.style(a,b,c):n.css(a,b) +},a,b,arguments.length>1)},show:function(){return Wb(this,!0)},hide:function(){return Wb(this)},toggle:function(a){return"boolean"==typeof a?a?this.show():this.hide():this.each(function(){V(this)?n(this).show():n(this).hide()})}});function $b(a,b,c,d,e){return new $b.prototype.init(a,b,c,d,e)}n.Tween=$b,$b.prototype={constructor:$b,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||"swing",this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(n.cssNumber[c]?"":"px")},cur:function(){var a=$b.propHooks[this.prop];return a&&a.get?a.get(this):$b.propHooks._default.get(this)},run:function(a){var b,c=$b.propHooks[this.prop];return this.pos=b=this.options.duration?n.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):$b.propHooks._default.set(this),this}},$b.prototype.init.prototype=$b.prototype,$b.propHooks={_default:{get:function(a){var b;return null==a.elem[a.prop]||a.elem.style&&null!=a.elem.style[a.prop]?(b=n.css(a.elem,a.prop,""),b&&"auto"!==b?b:0):a.elem[a.prop]},set:function(a){n.fx.step[a.prop]?n.fx.step[a.prop](a):a.elem.style&&(null!=a.elem.style[n.cssProps[a.prop]]||n.cssHooks[a.prop])?n.style(a.elem,a.prop,a.now+a.unit):a.elem[a.prop]=a.now}}},$b.propHooks.scrollTop=$b.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},n.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2}},n.fx=$b.prototype.init,n.fx.step={};var _b,ac,bc=/^(?:toggle|show|hide)$/,cc=new RegExp("^(?:([+-])=|)("+T+")([a-z%]*)$","i"),dc=/queueHooks$/,ec=[jc],fc={"*":[function(a,b){var c=this.createTween(a,b),d=c.cur(),e=cc.exec(b),f=e&&e[3]||(n.cssNumber[a]?"":"px"),g=(n.cssNumber[a]||"px"!==f&&+d)&&cc.exec(n.css(c.elem,a)),h=1,i=20;if(g&&g[3]!==f){f=f||g[3],e=e||[],g=+d||1;do h=h||".5",g/=h,n.style(c.elem,a,g+f);while(h!==(h=c.cur()/d)&&1!==h&&--i)}return e&&(g=c.start=+g||+d||0,c.unit=f,c.end=e[1]?g+(e[1]+1)*e[2]:+e[2]),c}]};function gc(){return setTimeout(function(){_b=void 0}),_b=n.now()}function hc(a,b){var c,d={height:a},e=0;for(b=b?1:0;4>e;e+=2-b)c=U[e],d["margin"+c]=d["padding"+c]=a;return b&&(d.opacity=d.width=a),d}function ic(a,b,c){for(var d,e=(fc[b]||[]).concat(fc["*"]),f=0,g=e.length;g>f;f++)if(d=e[f].call(c,b,a))return d}function jc(a,b,c){var d,e,f,g,h,i,j,k,m=this,o={},p=a.style,q=a.nodeType&&V(a),r=n._data(a,"fxshow");c.queue||(h=n._queueHooks(a,"fx"),null==h.unqueued&&(h.unqueued=0,i=h.empty.fire,h.empty.fire=function(){h.unqueued||i()}),h.unqueued++,m.always(function(){m.always(function(){h.unqueued--,n.queue(a,"fx").length||h.empty.fire()})})),1===a.nodeType&&("height"in b||"width"in b)&&(c.overflow=[p.overflow,p.overflowX,p.overflowY],j=n.css(a,"display"),k=Gb(a.nodeName),"none"===j&&(j=k),"inline"===j&&"none"===n.css(a,"float")&&(l.inlineBlockNeedsLayout&&"inline"!==k?p.zoom=1:p.display="inline-block")),c.overflow&&(p.overflow="hidden",l.shrinkWrapBlocks()||m.always(function(){p.overflow=c.overflow[0],p.overflowX=c.overflow[1],p.overflowY=c.overflow[2]}));for(d in b)if(e=b[d],bc.exec(e)){if(delete b[d],f=f||"toggle"===e,e===(q?"hide":"show")){if("show"!==e||!r||void 0===r[d])continue;q=!0}o[d]=r&&r[d]||n.style(a,d)}if(!n.isEmptyObject(o)){r?"hidden"in r&&(q=r.hidden):r=n._data(a,"fxshow",{}),f&&(r.hidden=!q),q?n(a).show():m.done(function(){n(a).hide()}),m.done(function(){var b;n._removeData(a,"fxshow");for(b in o)n.style(a,b,o[b])});for(d in o)g=ic(q?r[d]:0,d,m),d in r||(r[d]=g.start,q&&(g.end=g.start,g.start="width"===d||"height"===d?1:0))}}function kc(a,b){var c,d,e,f,g;for(c in a)if(d=n.camelCase(c),e=b[d],f=a[c],n.isArray(f)&&(e=f[1],f=a[c]=f[0]),c!==d&&(a[d]=f,delete a[c]),g=n.cssHooks[d],g&&"expand"in g){f=g.expand(f),delete a[d];for(c in f)c in a||(a[c]=f[c],b[c]=e)}else b[d]=e}function lc(a,b,c){var d,e,f=0,g=ec.length,h=n.Deferred().always(function(){delete i.elem}),i=function(){if(e)return!1;for(var b=_b||gc(),c=Math.max(0,j.startTime+j.duration-b),d=c/j.duration||0,f=1-d,g=0,i=j.tweens.length;i>g;g++)j.tweens[g].run(f);return h.notifyWith(a,[j,f,c]),1>f&&i?c:(h.resolveWith(a,[j]),!1)},j=h.promise({elem:a,props:n.extend({},b),opts:n.extend(!0,{specialEasing:{}},c),originalProperties:b,originalOptions:c,startTime:_b||gc(),duration:c.duration,tweens:[],createTween:function(b,c){var d=n.Tween(a,j.opts,b,c,j.opts.specialEasing[b]||j.opts.easing);return j.tweens.push(d),d},stop:function(b){var c=0,d=b?j.tweens.length:0;if(e)return this;for(e=!0;d>c;c++)j.tweens[c].run(1);return b?h.resolveWith(a,[j,b]):h.rejectWith(a,[j,b]),this}}),k=j.props;for(kc(k,j.opts.specialEasing);g>f;f++)if(d=ec[f].call(j,a,k,j.opts))return d;return n.map(k,ic,j),n.isFunction(j.opts.start)&&j.opts.start.call(a,j),n.fx.timer(n.extend(i,{elem:a,anim:j,queue:j.opts.queue})),j.progress(j.opts.progress).done(j.opts.done,j.opts.complete).fail(j.opts.fail).always(j.opts.always)}n.Animation=n.extend(lc,{tweener:function(a,b){n.isFunction(a)?(b=a,a=["*"]):a=a.split(" ");for(var c,d=0,e=a.length;e>d;d++)c=a[d],fc[c]=fc[c]||[],fc[c].unshift(b)},prefilter:function(a,b){b?ec.unshift(a):ec.push(a)}}),n.speed=function(a,b,c){var d=a&&"object"==typeof a?n.extend({},a):{complete:c||!c&&b||n.isFunction(a)&&a,duration:a,easing:c&&b||b&&!n.isFunction(b)&&b};return d.duration=n.fx.off?0:"number"==typeof d.duration?d.duration:d.duration in n.fx.speeds?n.fx.speeds[d.duration]:n.fx.speeds._default,(null==d.queue||d.queue===!0)&&(d.queue="fx"),d.old=d.complete,d.complete=function(){n.isFunction(d.old)&&d.old.call(this),d.queue&&n.dequeue(this,d.queue)},d},n.fn.extend({fadeTo:function(a,b,c,d){return this.filter(V).css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=n.isEmptyObject(a),f=n.speed(b,c,d),g=function(){var b=lc(this,n.extend({},a),f);(e||n._data(this,"finish"))&&b.stop(!0)};return g.finish=g,e||f.queue===!1?this.each(g):this.queue(f.queue,g)},stop:function(a,b,c){var d=function(a){var b=a.stop;delete a.stop,b(c)};return"string"!=typeof a&&(c=b,b=a,a=void 0),b&&a!==!1&&this.queue(a||"fx",[]),this.each(function(){var b=!0,e=null!=a&&a+"queueHooks",f=n.timers,g=n._data(this);if(e)g[e]&&g[e].stop&&d(g[e]);else for(e in g)g[e]&&g[e].stop&&dc.test(e)&&d(g[e]);for(e=f.length;e--;)f[e].elem!==this||null!=a&&f[e].queue!==a||(f[e].anim.stop(c),b=!1,f.splice(e,1));(b||!c)&&n.dequeue(this,a)})},finish:function(a){return a!==!1&&(a=a||"fx"),this.each(function(){var b,c=n._data(this),d=c[a+"queue"],e=c[a+"queueHooks"],f=n.timers,g=d?d.length:0;for(c.finish=!0,n.queue(this,a,[]),e&&e.stop&&e.stop.call(this,!0),b=f.length;b--;)f[b].elem===this&&f[b].queue===a&&(f[b].anim.stop(!0),f.splice(b,1));for(b=0;g>b;b++)d[b]&&d[b].finish&&d[b].finish.call(this);delete c.finish})}}),n.each(["toggle","show","hide"],function(a,b){var c=n.fn[b];n.fn[b]=function(a,d,e){return null==a||"boolean"==typeof a?c.apply(this,arguments):this.animate(hc(b,!0),a,d,e)}}),n.each({slideDown:hc("show"),slideUp:hc("hide"),slideToggle:hc("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){n.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),n.timers=[],n.fx.tick=function(){var a,b=n.timers,c=0;for(_b=n.now();c<b.length;c++)a=b[c],a()||b[c]!==a||b.splice(c--,1);b.length||n.fx.stop(),_b=void 0},n.fx.timer=function(a){n.timers.push(a),a()?n.fx.start():n.timers.pop()},n.fx.interval=13,n.fx.start=function(){ac||(ac=setInterval(n.fx.tick,n.fx.interval))},n.fx.stop=function(){clearInterval(ac),ac=null},n.fx.speeds={slow:600,fast:200,_default:400},n.fn.delay=function(a,b){return a=n.fx?n.fx.speeds[a]||a:a,b=b||"fx",this.queue(b,function(b,c){var d=setTimeout(b,a);c.stop=function(){clearTimeout(d)}})},function(){var a,b,c,d,e=z.createElement("div");e.setAttribute("className","t"),e.innerHTML=" <link/><table></table><a href='/a'>a</a><input type='checkbox'/>",a=e.getElementsByTagName("a")[0],c=z.createElement("select"),d=c.appendChild(z.createElement("option")),b=e.getElementsByTagName("input")[0],a.style.cssText="top:1px",l.getSetAttribute="t"!==e.className,l.style=/top/.test(a.getAttribute("style")),l.hrefNormalized="/a"===a.getAttribute("href"),l.checkOn=!!b.value,l.optSelected=d.selected,l.enctype=!!z.createElement("form").enctype,c.disabled=!0,l.optDisabled=!d.disabled,b=z.createElement("input"),b.setAttribute("value",""),l.input=""===b.getAttribute("value"),b.value="t",b.setAttribute("type","radio"),l.radioValue="t"===b.value,a=b=c=d=e=null}();var mc=/\r/g;n.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=n.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,n(this).val()):a,null==e?e="":"number"==typeof e?e+="":n.isArray(e)&&(e=n.map(e,function(a){return null==a?"":a+""})),b=n.valHooks[this.type]||n.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=n.valHooks[e.type]||n.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(mc,""):null==c?"":c)}}}),n.extend({valHooks:{option:{get:function(a){var b=n.find.attr(a,"value");return null!=b?b:n.text(a)}},select:{get:function(a){for(var b,c,d=a.options,e=a.selectedIndex,f="select-one"===a.type||0>e,g=f?null:[],h=f?e+1:d.length,i=0>e?h:f?e:0;h>i;i++)if(c=d[i],!(!c.selected&&i!==e||(l.optDisabled?c.disabled:null!==c.getAttribute("disabled"))||c.parentNode.disabled&&n.nodeName(c.parentNode,"optgroup"))){if(b=n(c).val(),f)return b;g.push(b)}return g},set:function(a,b){var c,d,e=a.options,f=n.makeArray(b),g=e.length;while(g--)if(d=e[g],n.inArray(n.valHooks.option.get(d),f)>=0)try{d.selected=c=!0}catch(h){d.scrollHeight}else d.selected=!1;return c||(a.selectedIndex=-1),e}}}}),n.each(["radio","checkbox"],function(){n.valHooks[this]={set:function(a,b){return n.isArray(b)?a.checked=n.inArray(n(a).val(),b)>=0:void 0}},l.checkOn||(n.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var nc,oc,pc=n.expr.attrHandle,qc=/^(?:checked|selected)$/i,rc=l.getSetAttribute,sc=l.input;n.fn.extend({attr:function(a,b){return W(this,n.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){n.removeAttr(this,a)})}}),n.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(a&&3!==f&&8!==f&&2!==f)return typeof a.getAttribute===L?n.prop(a,b,c):(1===f&&n.isXMLDoc(a)||(b=b.toLowerCase(),d=n.attrHooks[b]||(n.expr.match.bool.test(b)?oc:nc)),void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?void 0:e):null!==c?d&&"set"in d&&void 0!==(e=d.set(a,c,b))?e:(a.setAttribute(b,c+""),c):void n.removeAttr(a,b))},removeAttr:function(a,b){var c,d,e=0,f=b&&b.match(F);if(f&&1===a.nodeType)while(c=f[e++])d=n.propFix[c]||c,n.expr.match.bool.test(c)?sc&&rc||!qc.test(c)?a[d]=!1:a[n.camelCase("default-"+c)]=a[d]=!1:n.attr(a,c,""),a.removeAttribute(rc?c:d)},attrHooks:{type:{set:function(a,b){if(!l.radioValue&&"radio"===b&&n.nodeName(a,"input")){var c=a.value;return a.setAttribute("type",b),c&&(a.value=c),b}}}}}),oc={set:function(a,b,c){return b===!1?n.removeAttr(a,c):sc&&rc||!qc.test(c)?a.setAttribute(!rc&&n.propFix[c]||c,c):a[n.camelCase("default-"+c)]=a[c]=!0,c}},n.each(n.expr.match.bool.source.match(/\w+/g),function(a,b){var c=pc[b]||n.find.attr;pc[b]=sc&&rc||!qc.test(b)?function(a,b,d){var e,f;return d||(f=pc[b],pc[b]=e,e=null!=c(a,b,d)?b.toLowerCase():null,pc[b]=f),e}:function(a,b,c){return c?void 0:a[n.camelCase("default-"+b)]?b.toLowerCase():null}}),sc&&rc||(n.attrHooks.value={set:function(a,b,c){return n.nodeName(a,"input")?void(a.defaultValue=b):nc&&nc.set(a,b,c)}}),rc||(nc={set:function(a,b,c){var d=a.getAttributeNode(c);return d||a.setAttributeNode(d=a.ownerDocument.createAttribute(c)),d.value=b+="","value"===c||b===a.getAttribute(c)?b:void 0}},pc.id=pc.name=pc.coords=function(a,b,c){var d;return c?void 0:(d=a.getAttributeNode(b))&&""!==d.value?d.value:null},n.valHooks.button={get:function(a,b){var c=a.getAttributeNode(b);return c&&c.specified?c.value:void 0},set:nc.set},n.attrHooks.contenteditable={set:function(a,b,c){nc.set(a,""===b?!1:b,c)}},n.each(["width","height"],function(a,b){n.attrHooks[b]={set:function(a,c){return""===c?(a.setAttribute(b,"auto"),c):void 0}}})),l.style||(n.attrHooks.style={get:function(a){return a.style.cssText||void 0},set:function(a,b){return a.style.cssText=b+""}});var tc=/^(?:input|select|textarea|button|object)$/i,uc=/^(?:a|area)$/i;n.fn.extend({prop:function(a,b){return W(this,n.prop,a,b,arguments.length>1)},removeProp:function(a){return a=n.propFix[a]||a,this.each(function(){try{this[a]=void 0,delete this[a]}catch(b){}})}}),n.extend({propFix:{"for":"htmlFor","class":"className"},prop:function(a,b,c){var d,e,f,g=a.nodeType;if(a&&3!==g&&8!==g&&2!==g)return f=1!==g||!n.isXMLDoc(a),f&&(b=n.propFix[b]||b,e=n.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=n.find.attr(a,"tabindex");return b?parseInt(b,10):tc.test(a.nodeName)||uc.test(a.nodeName)&&a.href?0:-1}}}}),l.hrefNormalized||n.each(["href","src"],function(a,b){n.propHooks[b]={get:function(a){return a.getAttribute(b,4)}}}),l.optSelected||(n.propHooks.selected={get:function(a){var b=a.parentNode;return b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex),null}}),n.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){n.propFix[this.toLowerCase()]=this}),l.enctype||(n.propFix.enctype="encoding");var vc=/[\t\r\n\f]/g;n.fn.extend({addClass:function(a){var b,c,d,e,f,g,h=0,i=this.length,j="string"==typeof a&&a;if(n.isFunction(a))return this.each(function(b){n(this).addClass(a.call(this,b,this.className))});if(j)for(b=(a||"").match(F)||[];i>h;h++)if(c=this[h],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(vc," "):" ")){f=0;while(e=b[f++])d.indexOf(" "+e+" ")<0&&(d+=e+" ");g=n.trim(d),c.className!==g&&(c.className=g)}return this},removeClass:function(a){var b,c,d,e,f,g,h=0,i=this.length,j=0===arguments.length||"string"==typeof a&&a;if(n.isFunction(a))return this.each(function(b){n(this).removeClass(a.call(this,b,this.className))});if(j)for(b=(a||"").match(F)||[];i>h;h++)if(c=this[h],d=1===c.nodeType&&(c.className?(" "+c.className+" ").replace(vc," "):"")){f=0;while(e=b[f++])while(d.indexOf(" "+e+" ")>=0)d=d.replace(" "+e+" "," ");g=a?n.trim(d):"",c.className!==g&&(c.className=g)}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):this.each(n.isFunction(a)?function(c){n(this).toggleClass(a.call(this,c,this.className,b),b)}:function(){if("string"===c){var b,d=0,e=n(this),f=a.match(F)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else(c===L||"boolean"===c)&&(this.className&&n._data(this,"__className__",this.className),this.className=this.className||a===!1?"":n._data(this,"__className__")||"")})},hasClass:function(a){for(var b=" "+a+" ",c=0,d=this.length;d>c;c++)if(1===this[c].nodeType&&(" "+this[c].className+" ").replace(vc," ").indexOf(b)>=0)return!0;return!1}}),n.each("blur focus focusin focusout load resize scroll unload click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup error contextmenu".split(" "),function(a,b){n.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),n.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)},bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}});var wc=n.now(),xc=/\?/,yc=/(,)|(\[|{)|(}|])|"(?:[^"\\\r\n]|\\["\\\/bfnrt]|\\u[\da-fA-F]{4})*"\s*:?|true|false|null|-?(?!0\d)\d+(?:\.\d+|)(?:[eE][+-]?\d+|)/g;n.parseJSON=function(b){if(a.JSON&&a.JSON.parse)return a.JSON.parse(b+"");var c,d=null,e=n.trim(b+"");return e&&!n.trim(e.replace(yc,function(a,b,e,f){return c&&b&&(d=0),0===d?a:(c=e||b,d+=!f-!e,"")}))?Function("return "+e)():n.error("Invalid JSON: "+b)},n.parseXML=function(b){var c,d;if(!b||"string"!=typeof b)return null;try{a.DOMParser?(d=new DOMParser,c=d.parseFromString(b,"text/xml")):(c=new ActiveXObject("Microsoft.XMLDOM"),c.async="false",c.loadXML(b))}catch(e){c=void 0}return c&&c.documentElement&&!c.getElementsByTagName("parsererror").length||n.error("Invalid XML: "+b),c};var zc,Ac,Bc=/#.*$/,Cc=/([?&])_=[^&]*/,Dc=/^(.*?):[ \t]*([^\r\n]*)\r?$/gm,Ec=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Fc=/^(?:GET|HEAD)$/,Gc=/^\/\//,Hc=/^([\w.+-]+:)(?:\/\/(?:[^\/?#]*@|)([^\/?#:]*)(?::(\d+)|)|)/,Ic={},Jc={},Kc="*/".concat("*");try{Ac=location.href}catch(Lc){Ac=z.createElement("a"),Ac.href="",Ac=Ac.href}zc=Hc.exec(Ac.toLowerCase())||[];function Mc(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(F)||[];if(n.isFunction(c))while(d=f[e++])"+"===d.charAt(0)?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Nc(a,b,c,d){var e={},f=a===Jc;function g(h){var i;return e[h]=!0,n.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Oc(a,b){var c,d,e=n.ajaxSettings.flatOptions||{};for(d in b)void 0!==b[d]&&((e[d]?a:c||(c={}))[d]=b[d]);return c&&n.extend(!0,a,c),a}function Pc(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===e&&(e=a.mimeType||b.getResponseHeader("Content-Type"));if(e)for(g in h)if(h[g]&&h[g].test(e)){i.unshift(g);break}if(i[0]in c)f=i[0];else{for(g in c){if(!i[0]||a.converters[g+" "+i[0]]){f=g;break}d||(d=g)}f=f||d}return f?(f!==i[0]&&i.unshift(f),c[f]):void 0}function Qc(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}n.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:Ac,type:"GET",isLocal:Ec.test(zc[1]),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Kc,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":n.parseJSON,"text xml":n.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Oc(Oc(a,n.ajaxSettings),b):Oc(n.ajaxSettings,a)},ajaxPrefilter:Mc(Ic),ajaxTransport:Mc(Jc),ajax:function(a,b){"object"==typeof a&&(b=a,a=void 0),b=b||{};var c,d,e,f,g,h,i,j,k=n.ajaxSetup({},b),l=k.context||k,m=k.context&&(l.nodeType||l.jquery)?n(l):n.event,o=n.Deferred(),p=n.Callbacks("once memory"),q=k.statusCode||{},r={},s={},t=0,u="canceled",v={readyState:0,getResponseHeader:function(a){var b;if(2===t){if(!j){j={};while(b=Dc.exec(f))j[b[1].toLowerCase()]=b[2]}b=j[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return 2===t?f:null},setRequestHeader:function(a,b){var c=a.toLowerCase();return t||(a=s[c]=s[c]||a,r[a]=b),this},overrideMimeType:function(a){return t||(k.mimeType=a),this},statusCode:function(a){var b;if(a)if(2>t)for(b in a)q[b]=[q[b],a[b]];else v.always(a[v.status]);return this},abort:function(a){var b=a||u;return i&&i.abort(b),x(0,b),this}};if(o.promise(v).complete=p.add,v.success=v.done,v.error=v.fail,k.url=((a||k.url||Ac)+"").replace(Bc,"").replace(Gc,zc[1]+"//"),k.type=b.method||b.type||k.method||k.type,k.dataTypes=n.trim(k.dataType||"*").toLowerCase().match(F)||[""],null==k.crossDomain&&(c=Hc.exec(k.url.toLowerCase()),k.crossDomain=!(!c||c[1]===zc[1]&&c[2]===zc[2]&&(c[3]||("http:"===c[1]?"80":"443"))===(zc[3]||("http:"===zc[1]?"80":"443")))),k.data&&k.processData&&"string"!=typeof k.data&&(k.data=n.param(k.data,k.traditional)),Nc(Ic,k,b,v),2===t)return v;h=k.global,h&&0===n.active++&&n.event.trigger("ajaxStart"),k.type=k.type.toUpperCase(),k.hasContent=!Fc.test(k.type),e=k.url,k.hasContent||(k.data&&(e=k.url+=(xc.test(e)?"&":"?")+k.data,delete k.data),k.cache===!1&&(k.url=Cc.test(e)?e.replace(Cc,"$1_="+wc++):e+(xc.test(e)?"&":"?")+"_="+wc++)),k.ifModified&&(n.lastModified[e]&&v.setRequestHeader("If-Modified-Since",n.lastModified[e]),n.etag[e]&&v.setRequestHeader("If-None-Match",n.etag[e])),(k.data&&k.hasContent&&k.contentType!==!1||b.contentType)&&v.setRequestHeader("Content-Type",k.contentType),v.setRequestHeader("Accept",k.dataTypes[0]&&k.accepts[k.dataTypes[0]]?k.accepts[k.dataTypes[0]]+("*"!==k.dataTypes[0]?", "+Kc+"; q=0.01":""):k.accepts["*"]);for(d in k.headers)v.setRequestHeader(d,k.headers[d]);if(k.beforeSend&&(k.beforeSend.call(l,v,k)===!1||2===t))return v.abort();u="abort";for(d in{success:1,error:1,complete:1})v[d](k[d]);if(i=Nc(Jc,k,b,v)){v.readyState=1,h&&m.trigger("ajaxSend",[v,k]),k.async&&k.timeout>0&&(g=setTimeout(function(){v.abort("timeout")},k.timeout));try{t=1,i.send(r,x)}catch(w){if(!(2>t))throw w;x(-1,w)}}else x(-1,"No Transport");function x(a,b,c,d){var j,r,s,u,w,x=b;2!==t&&(t=2,g&&clearTimeout(g),i=void 0,f=d||"",v.readyState=a>0?4:0,j=a>=200&&300>a||304===a,c&&(u=Pc(k,v,c)),u=Qc(k,u,v,j),j?(k.ifModified&&(w=v.getResponseHeader("Last-Modified"),w&&(n.lastModified[e]=w),w=v.getResponseHeader("etag"),w&&(n.etag[e]=w)),204===a||"HEAD"===k.type?x="nocontent":304===a?x="notmodified":(x=u.state,r=u.data,s=u.error,j=!s)):(s=x,(a||!x)&&(x="error",0>a&&(a=0))),v.status=a,v.statusText=(b||x)+"",j?o.resolveWith(l,[r,x,v]):o.rejectWith(l,[v,x,s]),v.statusCode(q),q=void 0,h&&m.trigger(j?"ajaxSuccess":"ajaxError",[v,k,j?r:s]),p.fireWith(l,[v,x]),h&&(m.trigger("ajaxComplete",[v,k]),--n.active||n.event.trigger("ajaxStop")))}return v},getJSON:function(a,b,c){return n.get(a,b,c,"json")},getScript:function(a,b){return n.get(a,void 0,b,"script")}}),n.each(["get","post"],function(a,b){n[b]=function(a,c,d,e){return n.isFunction(c)&&(e=e||d,d=c,c=void 0),n.ajax({url:a,type:b,dataType:e,data:c,success:d})}}),n.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(a,b){n.fn[b]=function(a){return this.on(b,a)}}),n._evalUrl=function(a){return n.ajax({url:a,type:"GET",dataType:"script",async:!1,global:!1,"throws":!0})},n.fn.extend({wrapAll:function(a){if(n.isFunction(a))return this.each(function(b){n(this).wrapAll(a.call(this,b))});if(this[0]){var b=n(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&1===a.firstChild.nodeType)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){return this.each(n.isFunction(a)?function(b){n(this).wrapInner(a.call(this,b))}:function(){var b=n(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=n.isFunction(a);return this.each(function(c){n(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(){return this.parent().each(function(){n.nodeName(this,"body")||n(this).replaceWith(this.childNodes)}).end()}}),n.expr.filters.hidden=function(a){return a.offsetWidth<=0&&a.offsetHeight<=0||!l.reliableHiddenOffsets()&&"none"===(a.style&&a.style.display||n.css(a,"display"))},n.expr.filters.visible=function(a){return!n.expr.filters.hidden(a)};var Rc=/%20/g,Sc=/\[\]$/,Tc=/\r?\n/g,Uc=/^(?:submit|button|image|reset|file)$/i,Vc=/^(?:input|select|textarea|keygen)/i;function Wc(a,b,c,d){var e;if(n.isArray(b))n.each(b,function(b,e){c||Sc.test(a)?d(a,e):Wc(a+"["+("object"==typeof e?b:"")+"]",e,c,d)});else if(c||"object"!==n.type(b))d(a,b);else for(e in b)Wc(a+"["+e+"]",b[e],c,d)}n.param=function(a,b){var c,d=[],e=function(a,b){b=n.isFunction(b)?b():null==b?"":b,d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};if(void 0===b&&(b=n.ajaxSettings&&n.ajaxSettings.traditional),n.isArray(a)||a.jquery&&!n.isPlainObject(a))n.each(a,function(){e(this.name,this.value)});else for(c in a)Wc(c,a[c],b,e);return d.join("&").replace(Rc,"+")},n.fn.extend({serialize:function(){return n.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=n.prop(this,"elements");return a?n.makeArray(a):this}).filter(function(){var a=this.type;return this.name&&!n(this).is(":disabled")&&Vc.test(this.nodeName)&&!Uc.test(a)&&(this.checked||!X.test(a))}).map(function(a,b){var c=n(this).val();return null==c?null:n.isArray(c)?n.map(c,function(a){return{name:b.name,value:a.replace(Tc,"\r\n")}}):{name:b.name,value:c.replace(Tc,"\r\n")}}).get()}}),n.ajaxSettings.xhr=void 0!==a.ActiveXObject?function(){return!this.isLocal&&/^(get|post|head|put|delete|options)$/i.test(this.type)&&$c()||_c()}:$c;var Xc=0,Yc={},Zc=n.ajaxSettings.xhr();a.ActiveXObject&&n(a).on("unload",function(){for(var a in Yc)Yc[a](void 0,!0)}),l.cors=!!Zc&&"withCredentials"in Zc,Zc=l.ajax=!!Zc,Zc&&n.ajaxTransport(function(a){if(!a.crossDomain||l.cors){var b;return{send:function(c,d){var e,f=a.xhr(),g=++Xc;if(f.open(a.type,a.url,a.async,a.username,a.password),a.xhrFields)for(e in a.xhrFields)f[e]=a.xhrFields[e];a.mimeType&&f.overrideMimeType&&f.overrideMimeType(a.mimeType),a.crossDomain||c["X-Requested-With"]||(c["X-Requested-With"]="XMLHttpRequest");for(e in c)void 0!==c[e]&&f.setRequestHeader(e,c[e]+"");f.send(a.hasContent&&a.data||null),b=function(c,e){var h,i,j;if(b&&(e||4===f.readyState))if(delete Yc[g],b=void 0,f.onreadystatechange=n.noop,e)4!==f.readyState&&f.abort();else{j={},h=f.status,"string"==typeof f.responseText&&(j.text=f.responseText);try{i=f.statusText}catch(k){i=""}h||!a.isLocal||a.crossDomain?1223===h&&(h=204):h=j.text?200:404}j&&d(h,i,j,f.getAllResponseHeaders())},a.async?4===f.readyState?setTimeout(b):f.onreadystatechange=Yc[g]=b:b()},abort:function(){b&&b(void 0,!0)}}}});function $c(){try{return new a.XMLHttpRequest}catch(b){}}function _c(){try{return new a.ActiveXObject("Microsoft.XMLHTTP")}catch(b){}}n.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/(?:java|ecma)script/},converters:{"text script":function(a){return n.globalEval(a),a}}}),n.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),n.ajaxTransport("script",function(a){if(a.crossDomain){var b,c=z.head||n("head")[0]||z.documentElement;return{send:function(d,e){b=z.createElement("script"),b.async=!0,a.scriptCharset&&(b.charset=a.scriptCharset),b.src=a.url,b.onload=b.onreadystatechange=function(a,c){(c||!b.readyState||/loaded|complete/.test(b.readyState))&&(b.onload=b.onreadystatechange=null,b.parentNode&&b.parentNode.removeChild(b),b=null,c||e(200,"success"))},c.insertBefore(b,c.firstChild)},abort:function(){b&&b.onload(void 0,!0)}}}});var ad=[],bd=/(=)\?(?=&|$)|\?\?/;n.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=ad.pop()||n.expando+"_"+wc++;return this[a]=!0,a}}),n.ajaxPrefilter("json jsonp",function(b,c,d){var e,f,g,h=b.jsonp!==!1&&(bd.test(b.url)?"url":"string"==typeof b.data&&!(b.contentType||"").indexOf("application/x-www-form-urlencoded")&&bd.test(b.data)&&"data");return h||"jsonp"===b.dataTypes[0]?(e=b.jsonpCallback=n.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,h?b[h]=b[h].replace(bd,"$1"+e):b.jsonp!==!1&&(b.url+=(xc.test(b.url)?"&":"?")+b.jsonp+"="+e),b.converters["script json"]=function(){return g||n.error(e+" was not called"),g[0]},b.dataTypes[0]="json",f=a[e],a[e]=function(){g=arguments},d.always(function(){a[e]=f,b[e]&&(b.jsonpCallback=c.jsonpCallback,ad.push(e)),g&&n.isFunction(f)&&f(g[0]),g=f=void 0}),"script"):void 0}),n.parseHTML=function(a,b,c){if(!a||"string"!=typeof a)return null;"boolean"==typeof b&&(c=b,b=!1),b=b||z;var d=v.exec(a),e=!c&&[];return d?[b.createElement(d[1])]:(d=n.buildFragment([a],b,e),e&&e.length&&n(e).remove(),n.merge([],d.childNodes))};var cd=n.fn.load;n.fn.load=function(a,b,c){if("string"!=typeof a&&cd)return cd.apply(this,arguments);var d,e,f,g=this,h=a.indexOf(" ");return h>=0&&(d=a.slice(h,a.length),a=a.slice(0,h)),n.isFunction(b)?(c=b,b=void 0):b&&"object"==typeof b&&(f="POST"),g.length>0&&n.ajax({url:a,type:f,dataType:"html",data:b}).done(function(a){e=arguments,g.html(d?n("<div>").append(n.parseHTML(a)).find(d):a)}).complete(c&&function(a,b){g.each(c,e||[a.responseText,b,a])}),this},n.expr.filters.animated=function(a){return n.grep(n.timers,function(b){return a===b.elem}).length};var dd=a.document.documentElement;function ed(a){return n.isWindow(a)?a:9===a.nodeType?a.defaultView||a.parentWindow:!1}n.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=n.css(a,"position"),l=n(a),m={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=n.css(a,"top"),i=n.css(a,"left"),j=("absolute"===k||"fixed"===k)&&n.inArray("auto",[f,i])>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),n.isFunction(b)&&(b=b.call(a,c,h)),null!=b.top&&(m.top=b.top-h.top+g),null!=b.left&&(m.left=b.left-h.left+e),"using"in b?b.using.call(a,m):l.css(m)}},n.fn.extend({offset:function(a){if(arguments.length)return void 0===a?this:this.each(function(b){n.offset.setOffset(this,a,b)});var b,c,d={top:0,left:0},e=this[0],f=e&&e.ownerDocument;if(f)return b=f.documentElement,n.contains(b,e)?(typeof e.getBoundingClientRect!==L&&(d=e.getBoundingClientRect()),c=ed(f),{top:d.top+(c.pageYOffset||b.scrollTop)-(b.clientTop||0),left:d.left+(c.pageXOffset||b.scrollLeft)-(b.clientLeft||0)}):d},position:function(){if(this[0]){var a,b,c={top:0,left:0},d=this[0];return"fixed"===n.css(d,"position")?b=d.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),n.nodeName(a[0],"html")||(c=a.offset()),c.top+=n.css(a[0],"borderTopWidth",!0),c.left+=n.css(a[0],"borderLeftWidth",!0)),{top:b.top-c.top-n.css(d,"marginTop",!0),left:b.left-c.left-n.css(d,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||dd;while(a&&!n.nodeName(a,"html")&&"static"===n.css(a,"position"))a=a.offsetParent;return a||dd})}}),n.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c=/Y/.test(b);n.fn[a]=function(d){return W(this,function(a,d,e){var f=ed(a);return void 0===e?f?b in f?f[b]:f.document.documentElement[d]:a[d]:void(f?f.scrollTo(c?n(f).scrollLeft():e,c?e:n(f).scrollTop()):a[d]=e)},a,d,arguments.length,null)}}),n.each(["top","left"],function(a,b){n.cssHooks[b]=Mb(l.pixelPosition,function(a,c){return c?(c=Kb(a,b),Ib.test(c)?n(a).position()[b]+"px":c):void 0})}),n.each({Height:"height",Width:"width"},function(a,b){n.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){n.fn[d]=function(d,e){var f=arguments.length&&(c||"boolean"!=typeof d),g=c||(d===!0||e===!0?"margin":"border");return W(this,function(b,c,d){var e;return n.isWindow(b)?b.document.documentElement["client"+a]:9===b.nodeType?(e=b.documentElement,Math.max(b.body["scroll"+a],e["scroll"+a],b.body["offset"+a],e["offset"+a],e["client"+a])):void 0===d?n.css(b,c,g):n.style(b,c,d,g)},b,f?d:void 0,f,null)}})}),n.fn.size=function(){return this.length},n.fn.andSelf=n.fn.addBack,"function"==typeof define&&define.amd&&define("jquery",[],function(){return n});var fd=a.jQuery,gd=a.$;return n.noConflict=function(b){return a.$===n&&(a.$=gd),b&&a.jQuery===n&&(a.jQuery=fd),n},typeof b===L&&(a.jQuery=a.$=n),n}); diff --git a/SpriteLibrary/Doc/Help/search.html b/SpriteLibrary/Doc/Help/search.html new file mode 100644 index 0000000..85a2912 --- /dev/null +++ b/SpriteLibrary/Doc/Help/search.html @@ -0,0 +1,35 @@ +<!DOCTYPE html> +<html> +<head> + <title>SpriteLibrary - Search</title> + <link rel="stylesheet" type="text/css" href="styles/branding.css" /> + <link rel="stylesheet" type="text/css" href="styles/branding-Website.css" /> + <script type="text/javascript" src="scripts/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="scripts/branding.js"></script> + <script type="text/javascript" src="scripts/branding-Website.js"></script> +</head> +<body onload="OnSearchPageLoad();"> + <div class="pageHeader" id="PageHeader"> + SpriteLibrary - Search + </div> + <div class="pageBody"> + <div class="searchContainer"> + <div style="float: left;"> + <form id="SearchForm" method="get" action="#" onsubmit="javascript:PerformSearch(); return false;"> + <input id="txtSearchText" type="text" maxlength="200" /> + <button id="HeaderSearchButton" type="submit" class="header-search-button"> + </button> + </form> + </div> +   <input type="checkbox" id="chkSortByTitle" onclick="javascript:PerformSearch();" /> + Sort by title + + + <div id="searchResults"> + </div> + + <a href="html/6b7227c0-7a6a-6342-3b08-917c7de429cc.htm">Back</a> + </div> + </div> +</body> +</html> diff --git a/SpriteLibrary/Doc/Help/styles/branding-Help1.css b/SpriteLibrary/Doc/Help/styles/branding-Help1.css new file mode 100644 index 0000000..8f7ba25 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-Help1.css @@ -0,0 +1,40 @@ +/* Define the userData cache persistence mechanism for Help 1 files */ +.userDataStyle { + behavior: url(#default#userdata); +} + +/* Style adjustments for Help 1 */ +.pageBody { + padding-top: 0px 20px 0px 0px; +} + +table { + width: 95%; + padding-right: 20px; +} + +table.members { + width: 95%; + padding-right: 20px; +} + +th p { + padding-bottom: 0px; +} + +td p { + padding-bottom: 5px; +} + +.codeSnippetContainerTabs { + top: 1px; +} + +.codeSnippetToolBarText { + top: -13px; +} + +.codeSnippetContainerTabSingle { + padding: 2px 15px 0px 15px; + height: 22px; +} diff --git a/SpriteLibrary/Doc/Help/styles/branding-HelpViewer.css b/SpriteLibrary/Doc/Help/styles/branding-HelpViewer.css new file mode 100644 index 0000000..951621b --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-HelpViewer.css @@ -0,0 +1,48 @@ +/* Style adjustments for Help Viewer */ +.pageBody { + padding-top: 0px 20px 0px 0px; +} + +table { + width: 95%; + padding-right: 20px; +} + +table.members { + width: 95%; + padding-right: 20px; +} + +th p { + padding-bottom: 0px; +} + +td p { + padding-bottom: 5px; +} + +.codeSnippetContainerTabs { + top: 1px; +} + +.codeSnippetToolBarText { + top: -13px; +} + +.codeSnippetContainerTabSingle { + padding: 2px 15px 0px 15px; + height: 22px; +} + +.codeSnippetContainerTab a:visited { + color: #000000; +} + +.codeSnippetContainerTabActive a:visited { + color: #000000; +} + +span.keyword { + color: #0000ff; + font-weight: normal; +} diff --git a/SpriteLibrary/Doc/Help/styles/branding-Website.css b/SpriteLibrary/Doc/Help/styles/branding-Website.css new file mode 100644 index 0000000..d39e08c --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-Website.css @@ -0,0 +1,156 @@ +/* Style adjustments for websites */ +.pageBody { + padding: 0px 20px 0px 0px; +} +.topicContent { + margin-left: 280px; +} + +/* Lightweight TOC */ +.tocCollapsed { + background: url('../icons/TocCollapsed.gif') no-repeat scroll center; + width: 17px; + height: 20px; + overflow: hidden; +} +.tocExpanded { + background: url('../icons/TocExpanded.gif') no-repeat scroll center; + width: 17px; + height: 20px; + overflow: hidden; +} +.tocResize { + position: absolute; + top: 90px; + left: 300px; + width: 5px; + height: 20px; + padding-right: 5px; +} +.tocResize img { + border: none; + cursor: pointer; +} +div#leftNav { + float: left; + margin: 0px -1px 0 0; + width: 280px; + min-height: 10px; + position: relative; + border-right: 1px solid #b6b6b6; + padding-left: 10px; + padding-top: 15px; +} +div#tocNav { + font-family: 'Segoe UI' ,Verdana,Arial; + overflow-x: hidden; + line-height: normal; + margin: -20px 0 0 -4px; +} +div#tocNav > div { + overflow-x: hidden; + white-space: normal; + width: auto; + margin-bottom: 5px; +} +div#leftNav a, div#leftNav a:link, div#leftNav a:visited { + color: #1364c4; + text-decoration: none; +} +div#leftNav a:hover { + color: #3390b1; +} +div#tocNav > div > a, div#tocNav > div > a:link, div#tocNav > div > a:visited { + display: block; + margin-left: 18px; + overflow: hidden; +} +div#tocNav > div.current > a, div#tocNav > div.current > a:link, div#tocNav > div.current > a:visited { + color: #000; + font-weight: bold; + text-decoration: none; +} +div#tocNav > div > a.tocExpanded, div#tocNav > div > a.tocCollapsed { + float: left; + display: inline-block; + margin-left: 0; + vertical-align: top; +} +div#tocResizableEW { + cursor: e-resize; + width: 15px; + top: 0; + height: 100%; + position: absolute; + display: block; + font-size: 0.5px; + right: -7px; +} +.toclevel0:first-child { + margin-top: 16px; +} +div#tocNav > div.toclevel1 { + padding-left: 17px; +} +div#tocNav > div.toclevel2 { + padding-left: 34px; +} +div#tocNav > div.toclevel3 { + padding-left: 51px; +} +div#tocNav > div.toclevel4 { + padding-left: 68px; +} +div#tocNav > div.toclevel5 { + padding-left: 85px; +} +div#tocNav > div.toclevel6 { + padding-left: 102px; +} +div#tocNav > div.toclevel7 { + padding-left: 119px; +} +div#tocNav > div.toclevel8 { + padding-left: 136px; +} +div#tocNav > div.toclevel9 { + padding-left: 153px; +} +div#tocNav > div.toclevel10 { + padding-left: 170px; +} + +/* Search form */ +form#SearchForm { + float: right; + background-color: #eee; + width: 280px; +} +form#SearchForm input { + background-color: #eee; + border: 0; + height: 22px; + width: 230px; + color: #3b3b3b; + display: inline-block; + margin: 1px 0 0 0; + padding: 1px 4px 1px 10px; +} +form#SearchForm button { + background: url('../icons/Search.png') no-repeat scroll center; + background-color: #eee; + float: right; + border: 0; + margin: 3px 2px 0 0; + cursor: pointer; + color: #3b3b3b; + width: 19px; + height: 18px; + overflow: hidden; +} +.searchContainer { + width: 700px; + margin-top: 50px; + margin-left: auto; + margin-right: auto; +} diff --git a/SpriteLibrary/Doc/Help/styles/branding-cs-CZ.css b/SpriteLibrary/Doc/Help/styles/branding-cs-CZ.css new file mode 100644 index 0000000..f38de74 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-cs-CZ.css @@ -0,0 +1,3 @@ +/* Start CS-CZ locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-de-DE.css b/SpriteLibrary/Doc/Help/styles/branding-de-DE.css new file mode 100644 index 0000000..4cf80ba --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-de-DE.css @@ -0,0 +1,3 @@ +/* Start DE-DE locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-en-US.css b/SpriteLibrary/Doc/Help/styles/branding-en-US.css new file mode 100644 index 0000000..248cbe5 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-en-US.css @@ -0,0 +1,3 @@ +/* Start EN-US locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-es-ES.css b/SpriteLibrary/Doc/Help/styles/branding-es-ES.css new file mode 100644 index 0000000..4a7ebbd --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-es-ES.css @@ -0,0 +1,3 @@ +/* Start ES-ES locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-fr-FR.css b/SpriteLibrary/Doc/Help/styles/branding-fr-FR.css new file mode 100644 index 0000000..d924dec --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-fr-FR.css @@ -0,0 +1,3 @@ +/* Start FR-FR locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-it-IT.css b/SpriteLibrary/Doc/Help/styles/branding-it-IT.css new file mode 100644 index 0000000..36c6b22 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-it-IT.css @@ -0,0 +1,3 @@ +/* Start IT-IT locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-ja-JP.css b/SpriteLibrary/Doc/Help/styles/branding-ja-JP.css new file mode 100644 index 0000000..403aa6d --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-ja-JP.css @@ -0,0 +1,18 @@ +/* Start JA-JP locale-specific CSS */ +body +{ + font-family: Segoe UI, Verdana, Arial, ＭＳＰゴシック; +} +pre +{ + font-family: Consolas, Courier, monospace, ＭＳゴシック; +} +span.tt +{ + font-family: Consolas, Courier, monospace, ＭＳゴシック; +} +span.code +{ + font-family: Consolas, Courier, monospace, ＭＳゴシック; +} +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-ko-KR.css b/SpriteLibrary/Doc/Help/styles/branding-ko-KR.css new file mode 100644 index 0000000..2b46e92 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-ko-KR.css @@ -0,0 +1,19 @@ +/* Start KO-KR locale-specific CSS */ +body +{ + font-family: Malgun Gothic, Segoe UI, Verdana, Arial; + font-size: 0.75em; /*9pt*/ +} +pre +{ + font-family: Consolas, Courier, monospace, 돋움체; +} +span.tt +{ + font-family: Consolas, Courier, monospace, 돋움체; +} +span.code +{ + font-family: Consolas, Courier, monospace, 돋움체; +} +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-pl-PL.css b/SpriteLibrary/Doc/Help/styles/branding-pl-PL.css new file mode 100644 index 0000000..19e9810 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-pl-PL.css @@ -0,0 +1,3 @@ +/* Start PL-PL locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-pt-BR.css b/SpriteLibrary/Doc/Help/styles/branding-pt-BR.css new file mode 100644 index 0000000..a0683b0 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-pt-BR.css @@ -0,0 +1,3 @@ +/* Start PT-BR locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-ru-RU.css b/SpriteLibrary/Doc/Help/styles/branding-ru-RU.css new file mode 100644 index 0000000..c31f83a --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-ru-RU.css @@ -0,0 +1,3 @@ +/* Start RU-RU locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-tr-TR.css b/SpriteLibrary/Doc/Help/styles/branding-tr-TR.css new file mode 100644 index 0000000..81ca462 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-tr-TR.css @@ -0,0 +1,3 @@ +/* Start TR-TR locale-specific CSS */ + +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-zh-CN.css b/SpriteLibrary/Doc/Help/styles/branding-zh-CN.css new file mode 100644 index 0000000..cf79e7c --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-zh-CN.css @@ -0,0 +1,18 @@ +/* Start ZH-CN locale-specific CSS */ +body +{ + font-family: MS YaHei, Simsun, Segoe UI, Verdana, Arial; +} +pre +{ + font-family: Consolas, Courier, monospace, 新宋体; +} +span.tt +{ + font-family: Consolas, Courier, monospace, 新宋体; +} +span.code +{ + font-family: Consolas, Courier, monospace, 新宋体; +} +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding-zh-TW.css b/SpriteLibrary/Doc/Help/styles/branding-zh-TW.css new file mode 100644 index 0000000..eab654f --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding-zh-TW.css @@ -0,0 +1,18 @@ +/* Start ZH-TW locale-specific CSS */ +body +{ + font-family: MS JhengHei, MingLiU, Segoe UI, Verdana, Arial; +} +pre +{ + font-family: Consolas, Courier, monospace, 細明體; +} +span.tt +{ + font-family: Consolas, Courier, monospace, 細明體; +} +span.code +{ + font-family: Consolas, Courier, monospace, 細明體; +} +/* End locale-specific CSS */ diff --git a/SpriteLibrary/Doc/Help/styles/branding.css b/SpriteLibrary/Doc/Help/styles/branding.css new file mode 100644 index 0000000..0ff8cb9 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/branding.css @@ -0,0 +1,577 @@ +/* General styles */ +body { + font-family: 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif; + font-size: 15px; + padding: 0; + margin: 0; + margin-left: auto; + margin-right: auto; + color: #000; +} +h1 { + font-family: 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif; + font-size: 2.5em; + font-weight: normal; + margin-top: 0; + color: #000; +} +h2, h3 { + font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif; + font-weight: normal; + margin: 0; + padding-bottom: 5px; + padding-top: 5px; + color: #000; +} +h2 { + font-size: 1.769em; +} +h3 { + font-size: 1.231em; +} +h4, .subHeading { + font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif; + font-size: 1.077em; + font-weight: normal; + margin: 0; + color: #000; +} +.subHeading { + margin-top: 5px; +} +h5, h6 { + font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif; + font-size: 1em; + font-weight: normal; + line-height: 130%; + margin: 0; + color: #000; +} +a, a:link { + text-decoration: none; + color: #1364c4; +} +a:visited, a:active { + text-decoration: none; + color: #03697a; +} +a:hover { + text-decoration: none; + color: #3390b1; +} +a.button, a.button:active, a.button:hover { + float: right; + background-color: #0080c0; + color: white; + padding: 6px 12px; + font-size: 14px; + border: 1px solid transparent; + border-radius: 4px; + margin-left: 6px; +} +a.button:link, a.button:visited { + color: white; +} +img { + border: 0; +} +p { + margin-top: 0; + margin-bottom: 0; + padding-bottom: 15px; + line-height: 18px; +} +q { + font-style: italic; +} +blockquote { + margin-top: 0px; +} +table { + border-collapse: collapse; + padding: 0; + margin-bottom: 15px; + font-size: 15px; + width: 100%; +} +td, th { + border-bottom: 1px solid #dbdbdb; + margin: 10px; + padding-top: 10px; + padding-bottom: 10px; + padding-right: 8px; + padding-left: 8px; +} +th { + background-color: #ededed; + color: #636363; + text-align: left; + padding-top: 5px; + padding-bottom: 5px; +} +td { + color: #2a2a2a; + vertical-align: top; +} +table p:last-child { + padding-bottom: 0; +} +table.members { + width: 100%; +} +table.members td { + min-width: 72px; +} +table.members img { + padding-right: 5px; +} +div.alert img { + padding-right: 5px; +} +ol { + margin-top: 0px; + margin-bottom: 10px; +} +ol ol { + list-style-type: lower-alpha; +} +ol ol ol { + list-style-type: lower-roman; +} +ul { + margin-top: 0px; + margin-bottom: 10px; +} +.noBullet { + list-style-type: none; + padding-left: 20px; +} +ul ul { + list-style-type: circle; +} +ul ul ul { + list-style-type: square; +} +dt { + font-weight: 600; +} +pre { + font-family: Consolas, Courier, monospace; + overflow: hidden; +} +.pageHeader { + font-family: 'Segoe UI' , Tahoma, Helvetica, Sans-Serif; + background-color: #333333; + color: #d0d0d0; + padding: 5px 10px; + vertical-align: middle; + height: 25px; +} +.pageBody { + padding: 0px; +} +.topicContent { + padding: 10px 10px 15px 10px; + overflow: visible; + border-left: 1px solid #bbb; +} +.pageFooter { + clear: both; + border-top: solid 1px #bbb; + padding: 10px; +} +.feedbackLink { +} +.iconColumn { + width: 100px; +} +.seeAlsoStyle { +} +table.titleTable td { + padding-top: 0px; + border-width: 0px; +} +td.titleColumn { + font-family: 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif; + font-size: 2.5em; + font-weight: normal; + margin-top: 0px; + padding-left: 0px; + color: #000; + vertical-align: middle; +} +td.logoColumn { + padding-left: 0px; + padding-right: 10px; + vertical-align: middle; + width: 1px; +} +td.logoColumnAbove { + padding: 0px 10px 0px 0px; + vertical-align: middle; +} +span.selflink { + color: #000066; +} +div.preliminary { + margin-top: 1em; + margin-bottom: 1em; + font-weight: bold; + color: #333333; +} +div.caption { + font-weight: bold; + font-size: 1em; /*12pt*/ + color: #003399; + padding-top: 5px; + padding-bottom: 5px; +} +.procedureSubHeading { + font-size: 1.1em; /*13.5pt*/ + font-weight: bold; +} +.summary { +} + +/* Collapsible region styles */ +.collapsibleAreaRegion { + margin-top: 15px; + margin-bottom: 15px; +} +.collapseToggle { + padding-right: 5px; +} +.collapsibleRegionTitle { + font-family: 'Segoe UI Semibold' , 'Segoe UI' , 'Lucida Grande' , Verdana, Arial, Helvetica, sans-serif !important; + font-style: normal !important; + font-size: 1.769em; + margin-top: 9px; + margin-bottom: 19px; + padding-top: 20px; + padding-bottom: 5px; + cursor: pointer; +} +.collapsibleSection { + padding: 0 0 0 20px; +} + +/* Syntax and code snippet styles */ +.codeSnippetContainer { + min-width: 260px; + margin-top: 10px; +} +.codeSnippetContainerTabs { + height: 23px; + vertical-align: middle; + position: relative; + z-index: 1; +} +.codeSnippetContainerTab { + padding: 0px 15px; + width: auto; + height: 22px; + color: #2a2a2a; + font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important; + font-size: 12px; + font-style: normal !important; + vertical-align: baseline; + float: left; +} +.codeSnippetContainerTabActive { + background: #f8f8f8; + padding: 0px 15px; + width: auto; + height: 22px; + color: #000000; + font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important; + font-size: 12px; + font-style: normal !important; + vertical-align: baseline; + border-top-color: #939393; + border-right-color: #939393; + border-left-color: #939393; + border-top-width: 1px; + border-right-width: 1px; + border-left-width: 1px; + border-top-style: solid; + border-right-style: solid; + border-left-style: solid; + float: left; +} +.codeSnippetContainerTabPhantom { + background: #f8f8f8; + padding: 0px 15px; + width: auto; + height: 22px; + color: #000000; + font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important; + font-size: 12px; + font-style: normal !important; + vertical-align: baseline; + border-top-color: #939393; + border-right-color: #939393; + border-left-color: #939393; + border-top-width: 1px; + border-right-width: 1px; + border-left-width: 1px; + border-top-style: solid; + border-right-style: solid; + border-left-style: solid; + float: left; + display: none; +} +.codeSnippetContainerTabSingle { + background: #f8f8f8; + padding: 2px 15px 0px 15px; + width: auto; + height: 20px; + color: #000000; + font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important; + font-size: 12px; + font-weight: bold; + font-style: normal !important; + vertical-align: baseline; + border-top-color: #939393; + border-right-color: #939393; + border-left-color: #939393; + border-top-width: 1px; + border-right-width: 1px; + border-left-width: 1px; + border-top-style: solid; + border-right-style: solid; + border-left-style: solid; + float: left; +} +.codeSnippetContainerTab a { + top: 2px; + color: #000000; + font-weight: bold; + text-decoration: none; + position: relative; +} +.codeSnippetContainerTab a:link { + color: #000000; +} +.codeSnippetContainerTab a:hover { + color: #136460; +} +.codeSnippetContainerTabActive a { + top: 2px; + color: #000000; + font-weight: bold; + text-decoration: none; + position: relative; + cursor: default; +} +.codeSnippetContainerTabActive a:link { + color: #000000; +} +.codeSnippetContainerTabActive a:hover { + color: #000000; +} +.codeSnippetContainerTabPhantom a { + top: 2px; + color: #000000; + font-weight: bold; + text-decoration: none; + position: relative; + cursor: default; +} +.codeSnippetContainerTabPhantom a:link { + color: #000000; +} +.codeSnippetContainerCodeContainer { + border: 1px solid #939393; + top: -1px; + margin-bottom: 12px; + position: relative; +} +.codeSnippetToolBar { + width: auto; + height: auto; +} +.codeSnippetToolBarText { + top: -8px; + width: auto; + height: 0px; + padding-right: 0px; + padding-left: 0px; + vertical-align: top; + float: right; + position: relative; +} +.codeSnippetToolBarText a { + color: #1364c4; + text-decoration: none; + padding-left: 8px; + padding-right: 8px; + font-family: "Segoe UI" , "Lucida Grande" , Verdana, Arial, Helvetica, sans-serif !important; + font-size: 10px; + font-style: normal !important; + text-decoration: none; + margin-right: 10px; + margin-left: 0px; + background-color: #ffffff; +} +.codeSnippetToolBarText a:link { + color: #1364c4; +} +.codeSnippetContainerCode { + margin: 0px; + padding: 10px; + width: auto; +} +.codeSnippetContainerCode div { + margin: 0px; + padding: 0px; +} +.codeSnippetContainerCode pre { + margin: 0px; + padding: 5px; + overflow: auto; + font-family: Consolas, Courier, monospace !important; + font-style: normal; + font-weight: normal; + -ms-word-wrap: normal; +} +.codeSnippetContainerCode .keyword { + color: #0000ff; + font-weight: normal; +} + +.copyCodeSnippet { +} + +/* Keyword and phrase styles */ +span.code, span.command { + font-family: Consolas, Courier, monospace; + color: #000066; +} +span.ui { + font-weight: bold; +} +span.math { + font-style: italic; +} +span.input { + font-weight: bold; +} +span.term { + font-style: italic; +} +span.label { + font-weight: bold; +} +span.foreignPhrase, span.phrase { + font-style: italic; +} +span.placeholder { + font-style: italic; +} +span.typeparameter { + font-style: italic; +} +span.identifier { +} +span.keyword { + font-weight: bold; +} +span.parameter { + font-style: italic; +} +dt span.parameter { + font-weight: normal; +} +span.literal, span.literalValue { + color: #cc0000; +} +span.comment { + color: #006633; +} +span.introStyle { + color: #a9a9a9; +} +span.nolink { + font-weight: bold; +} + +/* Auto-outline styles */ +ul.autoOutline { +} +li.outlineSectionEntry { +} +div.outlineSectionEntrySummary { +} + +/* Media styles */ +div.mediaNear { + text-align: left; + margin-top: 1em; + margin-bottom: 1em; +} +div.mediaFar { + text-align: right; + margin-top: 1em; + margin-bottom: 1em; +} +div.mediaCenter { + text-align: center; + margin-top: 1em; + margin-bottom: 1em; +} +span.captionLead { + font-weight: bold; + margin-right: .5em; +} +span.media img { + vertical-align: top; +} + +/* Glossary styles */ +div.glossaryDiv { +} +div.glossaryLetterBar { +} +hr.glossaryRule { +} +h3.glossaryGroupHeading { + color: #808080; +} +div.glossaryGroup { +} +dl.glossaryGroupList { + margin: 0; + color: Black; +} +dt.glossaryEntry { + margin-left: 2em; +} +dd.glossaryEntry { + margin-left: 2em; + margin-bottom: 2em; +} +div.relatedEntry { + margin-bottom: 4px; +} + +/* Bibliography styles */ +div.bibliographStyle { + padding-top: 5px; +} +span.bibliographyNumber { +} +span.bibliographyAuthor { + font-weight: bold; +} +span.bibliographyTitle { + font-style: italic; +} +span.bibliographyPublisher { +} +sup.citation a:link a:visited a:active { + text-decoration: none; +} + +/* Placeholder for the Help 1 user data style class */ +.userDataStyle { +} diff --git a/SpriteLibrary/Doc/Help/styles/highlight.css b/SpriteLibrary/Doc/Help/styles/highlight.css new file mode 100644 index 0000000..04eb6d2 --- /dev/null +++ b/SpriteLibrary/Doc/Help/styles/highlight.css @@ -0,0 +1,27 @@ +.highlight-inline { color: #000066; font-size: 9pt; font-family: Consolas, "Courier New", Courier, monospace; } +.highlight-pre { clear: both; width: 99.5%; background-color: #EFEFF7; padding: 0.4em; font-size: 9pt; font-family: Consolas, "Courier New", Courier, monospace; margin-top: 0px; margin-bottom: 1em; } +.highlight-comment { color: #006633; } +.highlight-literal { color: #CC0000; } +.highlight-number { color: #009966; } +.highlight-keyword { color: #0000FF; } +.highlight-preprocessor { color: #996666; } +.highlight-xml-tag { color: #AA4400 } +.highlight-xml-bracket { color: #0000FF } +.highlight-xml-comment { color: #006633 } +.highlight-xml-cdata { color: #AA0088 } +.highlight-xml-attribute-name { color: #0000FF } +.highlight-xml-attribute-equal { color: #000000 } +.highlight-xml-attribute-value {color: #CC0000 } +.highlight-title { font-weight: bold; margin-top: 1em; margin-bottom: 2px; border-bottom: gray 1px solid; padding-bottom: 3px; } +.highlight-copycode { float: right; padding-right: 10px; font-weight: normal; cursor: pointer; } +.highlight-copycode_h { float: right; padding-right: 10px; font-weight: normal; cursor: pointer; text-decoration: underline} +.highlight-lineno { font-size: 80%; color: black } +.highlight-lnborder { border-right-style: solid; border-right-width: 1px; border-color: gray; padding-right: 4px; margin-right: 4px; width: 4px;} +.highlight-spacer { padding-right: 20px; } +.highlight-spacerShort { padding-right: 5px; } +.highlight-collapsebox { cursor: pointer; color: black; text-align: center; border-style: solid; border-width: 1px; border-color: gray; margin-left: 2px; margin-right: 5px; } +.highlight-collapsed { border-style: solid; border-width: 1px; border-color: gray; margin: 2px; color: gray; } +.highlight-expanded { border-left-style: solid; border-left-width: 1px; border-color: gray; margin-left: 2px; margin-right: 10px; } +.highlight-endblock { border-left-style: solid; border-left-width: 1px; border-bottom-style: solid; border-bottom-width: 1px; border-color: gray; margin-left: 2px; margin-right: 10px; } +.highlight-pshell-cmdlet { color: #5A9EA5; font-weight: bold; } +.highlight-namespace { color: #008284; } diff --git a/SpriteLibrary/Doc/Help/toc/07a473e4-4716-e5b9-c7d2-c4748265fc58.xml b/SpriteLibrary/Doc/Help/toc/07a473e4-4716-e5b9-c7d2-c4748265fc58.xml new file mode 100644 index 0000000..ff052d6 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/07a473e4-4716-e5b9-c7d2-c4748265fc58.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteController Class" Url="html/07a473e4-4716-e5b9-c7d2-c4748265fc58.htm"><HelpTOCNode Title="SpriteController Constructor " Url="html/323c4f03-703d-0898-c73e-40eb5784c05f.htm" HasChildren="true" /><HelpTOCNode Title="SpriteController Properties" Url="html/c6c542de-2b1f-1086-b5b2-56b7e9a9525f.htm" HasChildren="true" /><HelpTOCNode Title="SpriteController Methods" Url="html/2788d4d5-88bf-1154-dd17-8d4b99a79118.htm" HasChildren="true" /><HelpTOCNode Title="SpriteController Events" Url="html/4141394a-0d7d-5cf8-6b01-0a4fb43159ab.htm" HasChildren="true" /><HelpTOCNode Title="SpriteController Fields" Url="html/92b04460-74f1-c388-f3ac-ea510ffc4e06.htm" HasChildren="true" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/154fc8b0-0d6c-003e-be50-c94da6bc4597.xml b/SpriteLibrary/Doc/Help/toc/154fc8b0-0d6c-003e-be50-c94da6bc4597.xml new file mode 100644 index 0000000..70652b9 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/154fc8b0-0d6c-003e-be50-c94da6bc4597.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="AddAnimation Method " Url="html/154fc8b0-0d6c-003e-be50-c94da6bc4597.htm"><HelpTOCNode Title="AddAnimation Method (Image)" Url="html/e45036ef-15fa-9fbc-ef24-5e48c8c8ad8d.htm" /><HelpTOCNode Title="AddAnimation Method (Image, Size)" Url="html/4a6fe677-5369-6c0a-1e61-81355aa238b1.htm" /><HelpTOCNode Title="AddAnimation Method (Image, Int32)" Url="html/5284b83c-61a7-aefe-4087-f7137551b783.htm" /><HelpTOCNode Title="AddAnimation Method (Int32, Int32)" Url="html/eb5261e9-43df-01a5-b974-25c2fd13309c.htm" /><HelpTOCNode Title="AddAnimation Method (Image, Int32, Int32)" Url="html/9d686d62-c22c-20ec-7455-b4adc8070b8c.htm" /><HelpTOCNode Title="AddAnimation Method (Int32, Boolean, Boolean)" Url="html/1730e5a3-3e48-72f7-f641-b7a70e5c2563.htm" /><HelpTOCNode Title="AddAnimation Method (Image, Int32, Int32, Int32)" Url="html/a50146be-5b11-1554-db6f-817ea76b9343.htm" /><HelpTOCNode Title="AddAnimation Method (Point, Image, Int32, Int32, Int32, Int32)" Url="html/8ae70e13-ebdf-d78f-d7a4-69825f6b8c26.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/1f2c365c-e65b-3894-2e47-41f07250bbc0.xml b/SpriteLibrary/Doc/Help/toc/1f2c365c-e65b-3894-2e47-41f07250bbc0.xml new file mode 100644 index 0000000..a8b5751 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/1f2c365c-e65b-3894-2e47-41f07250bbc0.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="MoveTo Method " Url="html/1f2c365c-e65b-3894-2e47-41f07250bbc0.htm"><HelpTOCNode Title="MoveTo Method (List(Point))" Url="html/16df05cc-8770-7cbe-f754-ba9e386674ad.htm" /><HelpTOCNode Title="MoveTo Method (Point)" Url="html/eefee0d8-fb59-4546-386a-53f40c545c43.htm" /><HelpTOCNode Title="MoveTo Method (Sprite)" Url="html/27051af5-8ad4-0b54-231d-456499ae5b51.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/2788d4d5-88bf-1154-dd17-8d4b99a79118.xml b/SpriteLibrary/Doc/Help/toc/2788d4d5-88bf-1154-dd17-8d4b99a79118.xml new file mode 100644 index 0000000..26e8d91 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/2788d4d5-88bf-1154-dd17-8d4b99a79118.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteController Methods" Url="html/2788d4d5-88bf-1154-dd17-8d4b99a79118.htm"><HelpTOCNode Title="AddSprite Method " Url="html/f28be11d-b67a-765c-441a-d7da336ccf77.htm" /><HelpTOCNode Title="AdjustPoint Method " Url="html/68ba53c6-5c0d-3dd4-b9bd-56852a3b98cd.htm" /><HelpTOCNode Title="AdjustRectangle Method " Url="html/4f100dc3-39b4-fea4-6d73-8ef39eea489c.htm" /><HelpTOCNode Title="AllSprites Method " Url="html/662ea0d6-7a35-be51-5a25-288752509d24.htm" /><HelpTOCNode Title="ChangeTickInterval Method " Url="html/bf55ab7f-78c8-3879-b8f8-464dc203791e.htm" /><HelpTOCNode Title="CountSpritesBasedOff Method " Url="html/dace8c3a-8d35-4ae7-ddf8-26e59dc161ae.htm" /><HelpTOCNode Title="DestroyAllSprites Method " Url="html/63fd5f6f-f592-0dbd-6fd2-ff4b999f012d.htm" /><HelpTOCNode Title="DestroySprite Method " Url="html/56b507fc-3071-20e9-63a7-b33484f3e687.htm" /><HelpTOCNode Title="DuplicateSprite Method " Url="html/ae6c1c82-0519-4751-0b6d-f264c484e4cb.htm" HasChildren="true" /><HelpTOCNode Title="Invalidate Method " Url="html/fd95464a-c61d-8ed2-a568-34b825efc047.htm" HasChildren="true" /><HelpTOCNode Title="IsKeyPressed Method " Url="html/50eae5e0-c59c-9d9c-d551-21dba8696ac9.htm" HasChildren="true" /><HelpTOCNode Title="KeysPressed Method " Url="html/bcb29da5-8d8d-fa11-90ea-3a0cc73a0df0.htm" /><HelpTOCNode Title="NameSprite Method " Url="html/a5292253-7fbd-5dfa-819f-1d67d27580d6.htm" /><HelpTOCNode Title="Pause Method " Url="html/d329fe20-e750-bf52-a75b-f2383bf1d35a.htm" /><HelpTOCNode Title="PlaceSpriteBehind Method " Url="html/0b27d26e-53e1-c9bd-0b52-8fe4714c831a.htm" /><HelpTOCNode Title="PlaceSpriteInFrontOf Method " Url="html/8d47a519-d5f7-c7f6-4ccb-0d310cab2435.htm" /><HelpTOCNode Title="RegisterKeyDownFunction Method " Url="html/af7fceb3-a35e-b016-3955-696b3a3c7a7e.htm" /><HelpTOCNode Title="RegisterKeyUpFunction Method " Url="html/b3e934e2-1ddf-35e3-0995-3b555539f33f.htm" /><HelpTOCNode Title="ReplaceOriginalImage Method " Url="html/2c9b874d-5097-98bf-908c-f6bac5d647d3.htm" HasChildren="true" /><HelpTOCNode Title="ResetKeypressState Method " Url="html/48ff9be7-1395-25af-3585-3d32eba07309.htm" /><HelpTOCNode Title="ReturnAdjustmentRatio Method " Url="html/41ac663a-2019-6a14-5ffd-16dfc7472578.htm" /><HelpTOCNode Title="ReturnPictureBoxAdjustedHeight Method " Url="html/447d1a9a-0e17-9827-2a01-438434c1b879.htm" /><HelpTOCNode Title="ReturnPictureBoxAdjustedPoint Method " Url="html/9469b7cf-55ee-5c2e-feb7-01c7e23a6350.htm" /><HelpTOCNode Title="ReturnPictureBoxAdjustedWidth Method " Url="html/7c73b68e-f842-bfee-55d8-b36488fb35b7.htm" /><HelpTOCNode Title="ReturnPointAdjustedForImage Method " Url="html/e58bfa3c-4722-7f3a-9610-0a0ce62bfe99.htm" /><HelpTOCNode Title="SoundIsFinished Method " Url="html/df0fd1e8-eac8-4f10-7f09-baa6127f3752.htm" /><HelpTOCNode Title="SoundPlay Method " Url="html/08442d70-3a79-fa24-4f3e-eddc5c102938.htm" /><HelpTOCNode Title="SpriteBackwards Method " Url="html/d516c33b-29ef-9613-62fb-b6717264a32b.htm" /><HelpTOCNode Title="SpriteForwards Method " Url="html/b5c75d58-f132-f3ff-217f-e69b252db748.htm" /><HelpTOCNode Title="SpriteFromName Method " Url="html/e8491570-1fda-7d8e-48b8-c15f26c41d01.htm" /><HelpTOCNode Title="SpritesAtImagePoint Method " Url="html/90511f90-497b-fc61-6984-15d76101a6f1.htm" /><HelpTOCNode Title="SpritesAtPoint Method " Url="html/3c18bbb7-e10c-1b96-754d-7dfc878e7cf4.htm" /><HelpTOCNode Title="SpritesBasedOff Method " Url="html/e05efb85-3736-fa59-2720-a460b898048a.htm" /><HelpTOCNode Title="SpritesBasedOffAnything Method " Url="html/c7991a63-f63c-20d8-0605-fab6e9f13392.htm" /><HelpTOCNode Title="SpritesInImageRectangle Method " Url="html/c2860c42-fc4c-78f8-7d32-195e74262434.htm" /><HelpTOCNode Title="SpritesThatHaveBeenDrawn Method " Url="html/2c4eb5db-5c4c-6fcd-716c-532c0e2c4f35.htm" /><HelpTOCNode Title="SpriteToBack Method " Url="html/5d32e0da-bbf2-10b5-ba20-fe5bdfec1963.htm" /><HelpTOCNode Title="SpriteToFront Method " Url="html/80b0403d-da14-c176-9d01-080fc170a67d.htm" /><HelpTOCNode Title="UnPause Method " Url="html/675951bb-e09a-e9ec-95d2-c0efaf187d6d.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/2c9b874d-5097-98bf-908c-f6bac5d647d3.xml b/SpriteLibrary/Doc/Help/toc/2c9b874d-5097-98bf-908c-f6bac5d647d3.xml new file mode 100644 index 0000000..1de9f6b --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/2c9b874d-5097-98bf-908c-f6bac5d647d3.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="ReplaceOriginalImage Method " Url="html/2c9b874d-5097-98bf-908c-f6bac5d647d3.htm"><HelpTOCNode Title="ReplaceOriginalImage Method " Url="html/49befa66-d9d0-400c-1fc2-ac57f17433f1.htm" /><HelpTOCNode Title="ReplaceOriginalImage Method (Image)" Url="html/eac30137-8237-e01a-ee3d-e599d117c03e.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/323c4f03-703d-0898-c73e-40eb5784c05f.xml b/SpriteLibrary/Doc/Help/toc/323c4f03-703d-0898-c73e-40eb5784c05f.xml new file mode 100644 index 0000000..f8e2297 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/323c4f03-703d-0898-c73e-40eb5784c05f.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteController Constructor " Url="html/323c4f03-703d-0898-c73e-40eb5784c05f.htm"><HelpTOCNode Title="SpriteController Constructor (PictureBox)" Url="html/dd581cb5-2630-cc79-5fcb-24bfcb817e03.htm" /><HelpTOCNode Title="SpriteController Constructor (PictureBox, EventHandler)" Url="html/d20e5816-faf3-723d-5f2d-ebff462012f1.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/4141394a-0d7d-5cf8-6b01-0a4fb43159ab.xml b/SpriteLibrary/Doc/Help/toc/4141394a-0d7d-5cf8-6b01-0a4fb43159ab.xml new file mode 100644 index 0000000..e64c220 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/4141394a-0d7d-5cf8-6b01-0a4fb43159ab.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteController Events" Url="html/4141394a-0d7d-5cf8-6b01-0a4fb43159ab.htm"><HelpTOCNode Title="DoTick Event" Url="html/ba843001-e657-41e8-7c66-c2473781ed40.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/4e310248-8e1a-76aa-edbc-a83f4ba9b425.xml b/SpriteLibrary/Doc/Help/toc/4e310248-8e1a-76aa-edbc-a83f4ba9b425.xml new file mode 100644 index 0000000..a3db71f --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/4e310248-8e1a-76aa-edbc-a83f4ba9b425.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpritePayload Class" Url="html/4e310248-8e1a-76aa-edbc-a83f4ba9b425.htm"><HelpTOCNode Title="SpritePayload Constructor " Url="html/6acc0e43-8cb8-535c-6f39-8163bb21447a.htm" /><HelpTOCNode Title="SpritePayload Methods" Url="html/5a5c3a2b-a675-c626-ced3-c958acc9f93e.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/50eae5e0-c59c-9d9c-d551-21dba8696ac9.xml b/SpriteLibrary/Doc/Help/toc/50eae5e0-c59c-9d9c-d551-21dba8696ac9.xml new file mode 100644 index 0000000..bf4cb8b --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/50eae5e0-c59c-9d9c-d551-21dba8696ac9.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="IsKeyPressed Method " Url="html/50eae5e0-c59c-9d9c-d551-21dba8696ac9.htm"><HelpTOCNode Title="IsKeyPressed Method " Url="html/bf10cc41-d9e2-52c5-0415-1083f0f55489.htm" /><HelpTOCNode Title="IsKeyPressed Method (Keys)" Url="html/7fc92c27-7895-2b2c-d4f1-ac682eec7af5.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/66013d9b-4126-7d65-05bb-94eb9d134be6.xml b/SpriteLibrary/Doc/Help/toc/66013d9b-4126-7d65-05bb-94eb9d134be6.xml new file mode 100644 index 0000000..467b080 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/66013d9b-4126-7d65-05bb-94eb9d134be6.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="Sprite Class" Url="html/66013d9b-4126-7d65-05bb-94eb9d134be6.htm"><HelpTOCNode Title="Sprite Constructor " Url="html/8a70b6b2-3e2d-3c6f-0d8c-18e6dea4368e.htm" HasChildren="true" /><HelpTOCNode Title="Sprite Properties" Url="html/bcdb40c8-478a-043c-5db0-393001600029.htm" HasChildren="true" /><HelpTOCNode Title="Sprite Methods" Url="html/abfab841-a96c-b22d-7cd8-fec3aba92510.htm" HasChildren="true" /><HelpTOCNode Title="Sprite Events" Url="html/bdcfa83c-c4a7-49f3-4d49-2f865014aee6.htm" HasChildren="true" /><HelpTOCNode Title="Sprite Fields" Url="html/6d383ed6-ff9b-f1b0-a53d-54ea41795870.htm" HasChildren="true" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/6b7227c0-7a6a-6342-3b08-917c7de429cc.xml b/SpriteLibrary/Doc/Help/toc/6b7227c0-7a6a-6342-3b08-917c7de429cc.xml new file mode 100644 index 0000000..ff64013 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/6b7227c0-7a6a-6342-3b08-917c7de429cc.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteLibrary" Url="html/6b7227c0-7a6a-6342-3b08-917c7de429cc.htm"><HelpTOCNode Title="Sprite Class" Url="html/66013d9b-4126-7d65-05bb-94eb9d134be6.htm" HasChildren="true" /><HelpTOCNode Title="Sprite.SpriteEventHandler Delegate" Url="html/1bab1e49-641a-5648-d034-4298d8158019.htm" /><HelpTOCNode Title="SpriteAdjustmentRatio Structure" Url="html/eae9601e-6da0-b304-9836-5e4b1e743f94.htm" HasChildren="true" /><HelpTOCNode Title="SpriteCollisionMethod Enumeration" Url="html/b78d4878-d301-191f-9c53-4f41d3e937e6.htm" /><HelpTOCNode Title="SpriteController Class" Url="html/07a473e4-4716-e5b9-c7d2-c4748265fc58.htm" HasChildren="true" /><HelpTOCNode Title="SpriteEventArgs Class" Url="html/f42e1d9a-273c-861f-b7db-6244c9266d2c.htm" HasChildren="true" /><HelpTOCNode Title="SpriteKeyEventHandler Delegate" Url="html/38678a79-da77-9ef7-e3e1-78ff96f5bd7b.htm" /><HelpTOCNode Title="SpritePauseType Enumeration" Url="html/efc2cb08-5c2b-c758-477e-d5739183a1ba.htm" /><HelpTOCNode Title="SpritePayload Class" Url="html/4e310248-8e1a-76aa-edbc-a83f4ba9b425.htm" HasChildren="true" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/6d383ed6-ff9b-f1b0-a53d-54ea41795870.xml b/SpriteLibrary/Doc/Help/toc/6d383ed6-ff9b-f1b0-a53d-54ea41795870.xml new file mode 100644 index 0000000..6010d4c --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/6d383ed6-ff9b-f1b0-a53d-54ea41795870.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="Sprite Fields" Url="html/6d383ed6-ff9b-f1b0-a53d-54ea41795870.htm"><HelpTOCNode Title="CannotMoveOutsideBox Field" Url="html/747bfb64-7646-38ee-09e3-65455ac597e5.htm" /><HelpTOCNode Title="MirrorHorizontally Field" Url="html/c39b03eb-911a-b0dc-fd7b-276ee464f6c7.htm" /><HelpTOCNode Title="MirrorVertically Field" Url="html/679ff642-b87f-24d6-80c5-434c06c71523.htm" /><HelpTOCNode Title="MovementSpeed Field" Url="html/e88e79e3-3edc-69e5-1854-23968928c073.htm" /><HelpTOCNode Title="payload Field" Url="html/3a7614d3-cfe9-ce52-55be-ca5324839e92.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/817b64cb-8c4b-af50-69ba-6762e8ae51c5.xml b/SpriteLibrary/Doc/Help/toc/817b64cb-8c4b-af50-69ba-6762e8ae51c5.xml new file mode 100644 index 0000000..ebc8b58 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/817b64cb-8c4b-af50-69ba-6762e8ae51c5.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteEventArgs Fields" Url="html/817b64cb-8c4b-af50-69ba-6762e8ae51c5.htm"><HelpTOCNode Title="Cancel Field" Url="html/ad1a395a-bbd4-d507-aa4d-1419f9b7df08.htm" /><HelpTOCNode Title="CollisionMethod Field" Url="html/18405dcf-237d-db66-cf64-0e08b0d16b41.htm" /><HelpTOCNode Title="NewLocation Field" Url="html/e058b656-39e3-5a55-4437-ee869ecbf35e.htm" /><HelpTOCNode Title="TargetSprite Field" Url="html/72a79555-fc4d-8b5b-1a9c-408fd55972e9.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/8a70b6b2-3e2d-3c6f-0d8c-18e6dea4368e.xml b/SpriteLibrary/Doc/Help/toc/8a70b6b2-3e2d-3c6f-0d8c-18e6dea4368e.xml new file mode 100644 index 0000000..9fe680e --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/8a70b6b2-3e2d-3c6f-0d8c-18e6dea4368e.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="Sprite Constructor " Url="html/8a70b6b2-3e2d-3c6f-0d8c-18e6dea4368e.htm"><HelpTOCNode Title="Sprite Constructor (Sprite, Boolean)" Url="html/bacd1b59-34a9-eb30-29b3-4fdc704a7b60.htm" /><HelpTOCNode Title="Sprite Constructor (SpriteController, Image)" Url="html/98f8bf30-d3ab-5f86-9fbf-9f76df20f2e6.htm" /><HelpTOCNode Title="Sprite Constructor (SpriteController, Image, Size)" Url="html/ecbab3a8-aa92-2bb6-efc6-cf26d1df424a.htm" /><HelpTOCNode Title="Sprite Constructor (SpriteController, Image, Int32, Int32)" Url="html/184a1964-91ec-6f0d-b7cf-95b722599d69.htm" /><HelpTOCNode Title="Sprite Constructor (SpriteController, Image, Int32, Int32, Int32)" Url="html/6541bf2d-e608-1bad-2e7f-1b0f2deb0c34.htm" /><HelpTOCNode Title="Sprite Constructor (Point, SpriteController, Image, Int32, Int32, Int32, Int32)" Url="html/8e88c5f2-f5d0-02df-c7cb-9701313411af.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/92b04460-74f1-c388-f3ac-ea510ffc4e06.xml b/SpriteLibrary/Doc/Help/toc/92b04460-74f1-c388-f3ac-ea510ffc4e06.xml new file mode 100644 index 0000000..be4eb8c --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/92b04460-74f1-c388-f3ac-ea510ffc4e06.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteController Fields" Url="html/92b04460-74f1-c388-f3ac-ea510ffc4e06.htm"><HelpTOCNode Title="OptimizeForLargeSpriteImages Field" Url="html/34a7b0e2-8fce-a07e-fff0-5460ba02a4cf.htm" /><HelpTOCNode Title="RandomNumberGenerator Field" Url="html/b9f05ef6-f80c-5676-1eca-d73833dca177.htm" /><HelpTOCNode Title="SpriteComparisonDelegate Field" Url="html/f640b978-f990-84a2-015a-40bf256fc37d.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/9c6cb5e5-0054-eab6-66d9-e6e0c1e8c444.xml b/SpriteLibrary/Doc/Help/toc/9c6cb5e5-0054-eab6-66d9-e6e0c1e8c444.xml new file mode 100644 index 0000000..620f07f --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/9c6cb5e5-0054-eab6-66d9-e6e0c1e8c444.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteAdjustmentRatio Fields" Url="html/9c6cb5e5-0054-eab6-66d9-e6e0c1e8c444.htm"><HelpTOCNode Title="height_ratio Field" Url="html/a8864de9-4275-a608-f5b0-26d4b313967d.htm" /><HelpTOCNode Title="width_ratio Field" Url="html/92e90a8d-e5eb-daea-2804-b99254f25433.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/abfab841-a96c-b22d-7cd8-fec3aba92510.xml b/SpriteLibrary/Doc/Help/toc/abfab841-a96c-b22d-7cd8-fec3aba92510.xml new file mode 100644 index 0000000..312f29b --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/abfab841-a96c-b22d-7cd8-fec3aba92510.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="Sprite Methods" Url="html/abfab841-a96c-b22d-7cd8-fec3aba92510.htm"><HelpTOCNode Title="AddAnimation Method " Url="html/154fc8b0-0d6c-003e-be50-c94da6bc4597.htm" HasChildren="true" /><HelpTOCNode Title="AnimateJustAFewTimes Method " Url="html/3bbc779a-f8e9-8c18-c3c3-89018dd77daf.htm" /><HelpTOCNode Title="AnimateOnce Method " Url="html/ff84ba57-4738-8ff0-2356-095dfe1cc159.htm" /><HelpTOCNode Title="CancelMoveTo Method " Url="html/adc84477-1eb3-bb14-ee09-0525268c45f4.htm" /><HelpTOCNode Title="ChangeAnimation Method " Url="html/25183ea9-6a42-63b0-8051-fd4b9c8dbfe7.htm" /><HelpTOCNode Title="ChangeAnimationSpeed Method " Url="html/93aee3f0-fb9a-e628-9224-0128a91d363a.htm" /><HelpTOCNode Title="ChangeFrameAnimationSpeed Method " Url="html/859526c5-9283-3edb-386b-905cbaa406fd.htm" /><HelpTOCNode Title="CheckSpriteHitsSprite Method " Url="html/5d507565-cf0d-de52-2253-b55396e3886a.htm" /><HelpTOCNode Title="ConvertDegreesToRadians Method " Url="html/fd3f0ed3-4608-2686-e248-8f2a1e6a2bac.htm" /><HelpTOCNode Title="ConvertRadiansToDegrees Method " Url="html/2695c170-24ea-95d2-7f85-34c3930416b5.htm" /><HelpTOCNode Title="Destroy Method " Url="html/bc474319-2c51-e93f-07e2-9728d609c563.htm" /><HelpTOCNode Title="GetAnimationSpeed Method " Url="html/d0e10a16-4614-56b2-3e21-ce841f26b3d8.htm" /><HelpTOCNode Title="GetFrameAnimationSpeed Method " Url="html/e38f911d-9d99-eac6-b9ea-bffd3d04678a.htm" /><HelpTOCNode Title="GetImage Method " Url="html/b29c2176-174b-e620-0e33-9a22730ad05f.htm" HasChildren="true" /><HelpTOCNode Title="GetSpriteBaseImageCenter Method " Url="html/ef8d63de-fe6f-104e-f66f-3fffcd4ff0eb.htm" /><HelpTOCNode Title="GetSpriteDegrees Method " Url="html/d5da80cc-4be3-3550-8bf9-5c460fbf2e15.htm" /><HelpTOCNode Title="GetSpritePictureboxCenter Method " Url="html/efb3089a-8900-83fe-ce65-f22e686d7477.htm" /><HelpTOCNode Title="GetSpriteRadans Method " Url="html/88cf999b-5b19-4cfc-adab-b0276f18431a.htm" /><HelpTOCNode Title="GetSpriteVector Method " Url="html/e9953cab-b878-4169-fda6-d5addecb267b.htm" /><HelpTOCNode Title="HideSprite Method " Url="html/e57f527d-aee3-7c4e-fc43-7219b7961fe0.htm" /><HelpTOCNode Title="IsPaused Method " Url="html/9474d6c2-30d9-a39b-3c10-b50286f93813.htm" /><HelpTOCNode Title="MoveTo Method " Url="html/1f2c365c-e65b-3894-2e47-41f07250bbc0.htm" HasChildren="true" /><HelpTOCNode Title="Pause Method " Url="html/db9f18b5-9947-5dfc-3174-39f4b1341b1c.htm" /><HelpTOCNode Title="PutBaseImageLocation Method " Url="html/adaddf64-5e6e-447b-5d81-c38398216201.htm" HasChildren="true" /><HelpTOCNode Title="PutPictureBoxLocation Method " Url="html/7cf36b8e-42dc-cc56-1e14-6f248286d92b.htm" /><HelpTOCNode Title="RecalcPictureBoxLocation Method " Url="html/ba26c365-f8d2-0a86-b3b6-1cfab946b3da.htm" /><HelpTOCNode Title="ReplaceImage Method " Url="html/0ce33e3f-7f15-3abb-69b9-6826b7d831d7.htm" /><HelpTOCNode Title="ReturnAdjustmentRatio Method " Url="html/56d803c5-e2ad-dd16-0592-b816f726498d.htm" /><HelpTOCNode Title="SendToBack Method " Url="html/c0d47063-6820-3464-ed46-94ffd2329683.htm" /><HelpTOCNode Title="SendToFront Method " Url="html/ef420c55-64ea-5230-e9e5-d8c13f98f74a.htm" /><HelpTOCNode Title="SetName Method " Url="html/36d40ecf-484f-3b53-43e4-87ed9108cb76.htm" /><HelpTOCNode Title="SetSize Method " Url="html/7cf8acaf-92f1-652e-4c2a-bfd920bc0479.htm" /><HelpTOCNode Title="SetSpriteDirection Method " Url="html/aebe0cd6-1499-7da2-2f96-c86d84189b58.htm" /><HelpTOCNode Title="SetSpriteDirectionDegrees Method " Url="html/0f4e570a-2888-8819-176b-9dd070ca7db4.htm" /><HelpTOCNode Title="SetSpriteDirectionRadians Method " Url="html/ec39133f-39d0-c9ef-e77b-e58ea8c9b2f6.htm" /><HelpTOCNode Title="SetSpriteDirectionToPoint Method " Url="html/d416e051-269c-c343-aece-3682b87f3cbc.htm" /><HelpTOCNode Title="SpriteAdjustedPoint Method " Url="html/0b9ae3b4-06a9-5ee6-9bc0-33377f8be55e.htm" /><HelpTOCNode Title="SpriteAtImagePoint Method " Url="html/509560bd-f402-7e7f-a461-46845061a5fc.htm" /><HelpTOCNode Title="SpriteAtPictureBoxPoint Method " Url="html/9e0d8841-7f6a-63b2-c5fb-5ba6ffa85436.htm" /><HelpTOCNode Title="SpriteCanMoveOnImage Method " Url="html/c2f3867b-b906-a526-c836-718da1546a78.htm" /><HelpTOCNode Title="SpriteCanMoveOnPictureBox Method " Url="html/995741fd-f6ea-f11e-ee46-c88de9307e8a.htm" /><HelpTOCNode Title="SpriteIntersectsRectangle Method " Url="html/96b717e2-d860-aa86-3760-d39620a2bb31.htm" /><HelpTOCNode Title="UnhideSprite Method " Url="html/6e92bfaf-2e6c-a3bc-e208-3f486f6b42fc.htm" /><HelpTOCNode Title="UnPause Method " Url="html/6707f122-af81-e57d-d937-e4000242446f.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/adaddf64-5e6e-447b-5d81-c38398216201.xml b/SpriteLibrary/Doc/Help/toc/adaddf64-5e6e-447b-5d81-c38398216201.xml new file mode 100644 index 0000000..cdbe8e9 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/adaddf64-5e6e-447b-5d81-c38398216201.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="PutBaseImageLocation Method " Url="html/adaddf64-5e6e-447b-5d81-c38398216201.htm"><HelpTOCNode Title="PutBaseImageLocation Method (Point)" Url="html/5b2d8b05-360b-44bc-2e7b-f1d4753cb0df.htm" /><HelpTOCNode Title="PutBaseImageLocation Method (Double, Double)" Url="html/00fa147e-bf27-6b9f-3f44-77f8e6c1a9cc.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/ae6c1c82-0519-4751-0b6d-f264c484e4cb.xml b/SpriteLibrary/Doc/Help/toc/ae6c1c82-0519-4751-0b6d-f264c484e4cb.xml new file mode 100644 index 0000000..8573a07 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/ae6c1c82-0519-4751-0b6d-f264c484e4cb.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="DuplicateSprite Method " Url="html/ae6c1c82-0519-4751-0b6d-f264c484e4cb.htm"><HelpTOCNode Title="DuplicateSprite Method (String)" Url="html/60fe71db-5ea2-cf93-f216-79b15a6779db.htm" /><HelpTOCNode Title="DuplicateSprite Method (Sprite)" Url="html/ef714268-ae13-47ad-c8a8-1b8bb39cfed9.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/b29c2176-174b-e620-0e33-9a22730ad05f.xml b/SpriteLibrary/Doc/Help/toc/b29c2176-174b-e620-0e33-9a22730ad05f.xml new file mode 100644 index 0000000..8dd6c98 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/b29c2176-174b-e620-0e33-9a22730ad05f.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="GetImage Method " Url="html/b29c2176-174b-e620-0e33-9a22730ad05f.htm"><HelpTOCNode Title="GetImage Method " Url="html/fcc3a02a-e676-c16e-32a4-4fc2c5b530d4.htm" /><HelpTOCNode Title="GetImage Method (Int32, Int32)" Url="html/4067393e-d724-b01d-dc77-947440c6c444.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/bcdb40c8-478a-043c-5db0-393001600029.xml b/SpriteLibrary/Doc/Help/toc/bcdb40c8-478a-043c-5db0-393001600029.xml new file mode 100644 index 0000000..12fc2e2 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/bcdb40c8-478a-043c-5db0-393001600029.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="Sprite Properties" Url="html/bcdb40c8-478a-043c-5db0-393001600029.htm"><HelpTOCNode Title="AnimationCount Property " Url="html/23ac9f1e-8033-78a2-030b-b12d6496c3dd.htm" /><HelpTOCNode Title="AnimationDone Property " Url="html/f0db6147-f3aa-d599-6371-a89da047bbc5.htm" /><HelpTOCNode Title="AnimationIndex Property " Url="html/f55ba01a-50d3-248c-5c34-ba32355db223.htm" /><HelpTOCNode Title="AutomaticallyMoves Property " Url="html/f7da08ef-ca8d-fd84-5c60-7bd966be6374.htm" /><HelpTOCNode Title="BaseImageLocation Property " Url="html/29f62d1a-212b-273e-582e-670c1ea2856c.htm" /><HelpTOCNode Title="Destroying Property " Url="html/0f7e6cfa-e1e4-1b7a-152d-5b3281ac8bfe.htm" /><HelpTOCNode Title="FrameIndex Property " Url="html/603ff402-efe2-bede-5c71-1a9583da0800.htm" /><HelpTOCNode Title="GetSize Property " Url="html/8b245db5-fbb6-18bc-d219-832668d1432a.htm" /><HelpTOCNode Title="GetVisibleSize Property " Url="html/af9edc83-1d26-349b-8105-6064a540e2c7.htm" /><HelpTOCNode Title="HasBeenDrawn Property " Url="html/f374c8cd-af01-f03a-1d31-0b46e0d8745c.htm" /><HelpTOCNode Title="ID Property " Url="html/8e41c462-a765-51e2-4c3b-de231acba259.htm" /><HelpTOCNode Title="MovingToPoint Property " Url="html/139d1443-5e11-02ed-7534-eb0f857804da.htm" /><HelpTOCNode Title="Opacity Property " Url="html/90a2e7f3-348b-d10b-ee6b-9397ef5daa18.htm" /><HelpTOCNode Title="PictureBoxLocation Property " Url="html/6273fa69-a784-9916-a8eb-5b16529fdf48.htm" /><HelpTOCNode Title="Rotation Property " Url="html/20db7ecc-35df-8911-2615-1f2b8777f03b.htm" /><HelpTOCNode Title="SpriteName Property " Url="html/e753341a-7040-8dda-8f1e-681e926e9292.htm" /><HelpTOCNode Title="SpriteOriginName Property " Url="html/7d21be0e-d534-6d93-1476-3aa585a8fea3.htm" /><HelpTOCNode Title="SpriteReachedEndPoint Property " Url="html/ae4a57de-4763-c9cb-c9e3-c6e186296fd8.htm" /><HelpTOCNode Title="VisibleHeight Property " Url="html/5b5ccc3b-4e41-862f-7bba-7d55a45c6747.htm" /><HelpTOCNode Title="VisibleWidth Property " Url="html/cd53c0db-02b1-e505-0dce-a7d4d7710d5c.htm" /><HelpTOCNode Title="Zvalue Property " Url="html/6adf23fc-b0f8-5abf-bd39-7dc44f060e7c.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/bdcfa83c-c4a7-49f3-4d49-2f865014aee6.xml b/SpriteLibrary/Doc/Help/toc/bdcfa83c-c4a7-49f3-4d49-2f865014aee6.xml new file mode 100644 index 0000000..39956e8 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/bdcfa83c-c4a7-49f3-4d49-2f865014aee6.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="Sprite Events" Url="html/bdcfa83c-c4a7-49f3-4d49-2f865014aee6.htm"><HelpTOCNode Title="CheckBeforeMove Event" Url="html/f4164c4a-55e1-87f7-95bd-7bae1d99326b.htm" /><HelpTOCNode Title="Click Event" Url="html/01fdd72c-b202-8593-db2a-e1373358dd66.htm" /><HelpTOCNode Title="ClickTransparent Event" Url="html/51c9d545-e5c3-888d-d033-17085734aa1d.htm" /><HelpTOCNode Title="MouseEnter Event" Url="html/17255a69-f623-3a42-a7ce-db1eb348581a.htm" /><HelpTOCNode Title="MouseEnterTransparent Event" Url="html/acf8f1b8-170d-0fa9-1ac9-41a086d97046.htm" /><HelpTOCNode Title="MouseHover Event" Url="html/d8964a64-57ec-3b0c-94b5-247707cd34e8.htm" /><HelpTOCNode Title="MouseHoverTransparent Event" Url="html/d7215876-6117-ce45-75a4-77dc00c386cd.htm" /><HelpTOCNode Title="MouseLeave Event" Url="html/7a4959c4-936a-b924-d525-7becb693a55b.htm" /><HelpTOCNode Title="MouseLeaveTransparent Event" Url="html/8ff96e56-6289-4c11-f351-4dbfe58a44cf.htm" /><HelpTOCNode Title="SpriteAnimationComplete Event" Url="html/0e8b825f-f8df-9f14-41ec-f00778409dfb.htm" /><HelpTOCNode Title="SpriteArrivedAtEndPoint Event" Url="html/e37ba69c-1cb3-693c-f4b1-8e37b12cbd23.htm" /><HelpTOCNode Title="SpriteArrivedAtWaypoint Event" Url="html/17ee5c77-8351-af30-dc43-9458d683a69e.htm" /><HelpTOCNode Title="SpriteBeingDestroyed Event" Url="html/64d54496-389b-21a7-0387-25878b2bcc4c.htm" /><HelpTOCNode Title="SpriteChangesAnimationFrames Event" Url="html/81ec308a-e52d-7e07-f9e0-50d0bf531a30.htm" /><HelpTOCNode Title="SpriteExitsPictureBox Event" Url="html/37ae1b7e-72db-69cb-f1c6-26242c07e2b5.htm" /><HelpTOCNode Title="SpriteHitsPictureBox Event" Url="html/3aabe50b-5222-99aa-4654-356baa30033a.htm" /><HelpTOCNode Title="SpriteHitsSprite Event" Url="html/acb35a6f-c89a-3a7d-146d-b85ccf68d8aa.htm" /><HelpTOCNode Title="SpriteInitializes Event" Url="html/2b1a75c9-0eb6-fb22-eeea-595ec3cc1bf8.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/c6c542de-2b1f-1086-b5b2-56b7e9a9525f.xml b/SpriteLibrary/Doc/Help/toc/c6c542de-2b1f-1086-b5b2-56b7e9a9525f.xml new file mode 100644 index 0000000..ebfff93 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/c6c542de-2b1f-1086-b5b2-56b7e9a9525f.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteController Properties" Url="html/c6c542de-2b1f-1086-b5b2-56b7e9a9525f.htm"><HelpTOCNode Title="BackgroundImage Property " Url="html/9d9cf5a5-3349-bfae-7d39-41082644a49e.htm" /><HelpTOCNode Title="OriginalImage Property " Url="html/7d3a40d7-0ee8-6117-8d32-b236da97778f.htm" /><HelpTOCNode Title="SpriteCount Property " Url="html/6e7ddbc9-4f71-533f-b99c-55a53ba4a843.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/eae9601e-6da0-b304-9836-5e4b1e743f94.xml b/SpriteLibrary/Doc/Help/toc/eae9601e-6da0-b304-9836-5e4b1e743f94.xml new file mode 100644 index 0000000..83b159a --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/eae9601e-6da0-b304-9836-5e4b1e743f94.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteAdjustmentRatio Structure" Url="html/eae9601e-6da0-b304-9836-5e4b1e743f94.htm"><HelpTOCNode Title="SpriteAdjustmentRatio Methods" Url="html/57a9f458-c6c8-d106-aad4-b2547736909a.htm" /><HelpTOCNode Title="SpriteAdjustmentRatio Fields" Url="html/9c6cb5e5-0054-eab6-66d9-e6e0c1e8c444.htm" HasChildren="true" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/f42e1d9a-273c-861f-b7db-6244c9266d2c.xml b/SpriteLibrary/Doc/Help/toc/f42e1d9a-273c-861f-b7db-6244c9266d2c.xml new file mode 100644 index 0000000..4d9a293 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/f42e1d9a-273c-861f-b7db-6244c9266d2c.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="SpriteEventArgs Class" Url="html/f42e1d9a-273c-861f-b7db-6244c9266d2c.htm"><HelpTOCNode Title="SpriteEventArgs Constructor " Url="html/fa691ac7-58fb-b5fc-0141-68300e3a7a89.htm" /><HelpTOCNode Title="SpriteEventArgs Methods" Url="html/4716eb02-e702-b61a-126a-362af50ca6d5.htm" /><HelpTOCNode Title="SpriteEventArgs Fields" Url="html/817b64cb-8c4b-af50-69ba-6762e8ae51c5.htm" HasChildren="true" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/fd95464a-c61d-8ed2-a568-34b825efc047.xml b/SpriteLibrary/Doc/Help/toc/fd95464a-c61d-8ed2-a568-34b825efc047.xml new file mode 100644 index 0000000..c7c90ec --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/fd95464a-c61d-8ed2-a568-34b825efc047.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOCNode Title="Invalidate Method " Url="html/fd95464a-c61d-8ed2-a568-34b825efc047.htm"><HelpTOCNode Title="Invalidate Method (Boolean)" Url="html/451487c4-0cca-2c80-9b71-b116cbe00d6e.htm" /><HelpTOCNode Title="Invalidate Method (Rectangle, Boolean)" Url="html/c57680f5-fd0e-a4a6-05a0-3a42de94edb8.htm" /></HelpTOCNode> \ No newline at end of file diff --git a/SpriteLibrary/Doc/Help/toc/roottoc.xml b/SpriteLibrary/Doc/Help/toc/roottoc.xml new file mode 100644 index 0000000..513a0a2 --- /dev/null +++ b/SpriteLibrary/Doc/Help/toc/roottoc.xml @@ -0,0 +1 @@ +<?xml version="1.0" encoding="utf-8"?><HelpTOC><HelpTOCNode Title="SpriteLibrary" Url="html/6b7227c0-7a6a-6342-3b08-917c7de429cc.htm" HasChildren="true" /></HelpTOC> \ No newline at end of file diff --git a/SpriteLibrary/Doc/MakeHelp.bat b/SpriteLibrary/Doc/MakeHelp.bat new file mode 100644 index 0000000..bf46f4f --- /dev/null +++ b/SpriteLibrary/Doc/MakeHelp.bat @@ -0,0 +1,2 @@ +"c:\Windows\Microsoft.NET\Framework64\v4.0.30319\MSBuild" /p:CleanIntermediates=True /p:Configuration=Release SpriteLibrary.shfbproj +pause \ No newline at end of file diff --git a/SpriteLibrary/Doc/PerlXML2Doc.pl b/SpriteLibrary/Doc/PerlXML2Doc.pl new file mode 100644 index 0000000..e12736a --- /dev/null +++ b/SpriteLibrary/Doc/PerlXML2Doc.pl @@ -0,0 +1,75 @@ +#!/usr/bin/perl + +# use module +use XML::Simple; +use Data::Dumper; + +# create object +$xml = new XML::Simple; + +# read XML file +$data = $xml->XMLin("../bin/Release/SpriteLibrary.XML"); +#print Dumper($data->{members}); + +print "<HTML>\n"; +foreach $type (P, M, E, F) +{ + print "<h2>Methods</h2>\n" if $type eq "M"; + print "<h2>Events</h2>\n" if $type eq "E"; + print "<h2>Properties</h2>\n" if $type eq "P"; + print "<h2>Functions</h2>\n" if $type eq "F"; + while(my ($key, $value) = each $data->{members}) + { + #print $key; + #while(my ($inkey, $invalue) = each $value) + foreach $inkey (sort keys $value) + { + $invalue = $value->{$inkey}; + if($inkey =~ /^$type/) + { + my $name = $inkey; + $name =~ s/^.:SpriteLibrary\.//; + next if $name =~ /\.Resources\./; + if($name =~ s/\#ctor//) + { + $name = "Constructor: $name"; + } + print "$name \n"; + #print Dumper($invalue); + my $summary = $invalue->{summary}; + $summary =~ s/^\s+|\s+$//g; + print "Summary: $summary \n" if defined $invalue->{summary}; + #if(defined $invalue->{returns}) + #{ + # if(UNIVERSAL::isa($invalue->{returns}, 'HASH')) + # { + # #print Dumper $invalue->{returns}; + # } + # else + # { + # print "Returns: $invalue->{returns} \n\n" if defined $invalue->{returns}; + # } + #} + #if(defined $invalue->{param}) + #{ + # print "Parameters\n"; + # print "<ul>\n"; + # while(my ($paramname, $description) = each $invalue->{param}) + # { + # + # print "<li>$paramname :"; + # #print Dumper $description; + # print $description->{content}; + # print " \n"; + # } + # print "</ul>\n"; + #} + #print "\n"; + } + +# print "$inkey = \n"; +# print Dumper($invalue);G + } + } +} +print "</HTML>\n"; diff --git a/SpriteLibrary/Doc/SpriteLibrary.shfbproj b/SpriteLibrary/Doc/SpriteLibrary.shfbproj new file mode 100644 index 0000000..1d1f3b8 --- /dev/null +++ b/SpriteLibrary/Doc/SpriteLibrary.shfbproj @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="utf-8"?> +<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> + <PropertyGroup> +  + <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration> + <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform> + <SchemaVersion>2.0</SchemaVersion> + <ProjectGuid>{4e12432b-f1c1-488c-a490-f692cd41468a}</ProjectGuid> + <SHFBSchemaVersion>2015.6.5.0</SHFBSchemaVersion> +  + <AssemblyName>Documentation</AssemblyName> + <RootNamespace>Documentation</RootNamespace> + <Name>Documentation</Name> +  + <FrameworkVersion>.NET Framework 4.5</FrameworkVersion> + <OutputPath>.\Help\</OutputPath> + <HtmlHelpName>Documentation</HtmlHelpName> + <Language>en-US</Language> + <SaveComponentCacheCapacity>100</SaveComponentCacheCapacity> + <BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity> + <HelpFileFormat>MSHelpViewer, Website</HelpFileFormat> + <IndentHtml>False</IndentHtml> + <KeepLogFile>True</KeepLogFile> + <DisableCodeBlockComponent>False</DisableCodeBlockComponent> + <CleanIntermediates>True</CleanIntermediates> + <ComponentConfigurations> + <ComponentConfig id="Syntax Component" enabled="True" xmlns=""> + <component id="Syntax Component"> + <syntax input="/document/reference" output="/document/syntax" renderReferenceLinks="false" /> + <generators> + {@SyntaxFilters} +</generators> + <containerElement name="codeSnippetGroup" addNoExampleTabs="true" includeOnSingleSnippets="false" groupingEnabled="{@CodeSnippetGrouping}" /> + <configurations> + <generator id="C#" /> + <generator id="Visual Basic"> + <includeLineContinuation value="false" /> + </generator> + <generator id="Visual Basic Usage"> + <includeLineContinuation value="false" /> + </generator> + <generator id="Managed C++" /> + <generator id="F#" /> + <generator id="J#" /> + <generator id="JScript" /> + <generator id="JavaScript" /> + <generator id="XAML Usage" /> + <generator id="ASP.NET" /> + </configurations> + </component> + </ComponentConfig> + </ComponentConfigurations> + <DocumentationSources> + <DocumentationSource sourceFile="..\bin\Release\SpriteLibrary.XML" /> + <DocumentationSource sourceFile="..\bin\Release\SpriteLibrary.dll" /> + </DocumentationSources> + <NamespaceSummaries> + </NamespaceSummaries> + <HelpFileVersion>1.0.0.0</HelpFileVersion> + <MaximumGroupParts>2</MaximumGroupParts> + <NamespaceGrouping>False</NamespaceGrouping> + <SyntaxFilters>C#</SyntaxFilters> + <SdkLinkTarget>Blank</SdkLinkTarget> + <RootNamespaceContainer>False</RootNamespaceContainer> + <PresentationStyle>VS2013</PresentationStyle> + <Preliminary>False</Preliminary> + <NamingMethod>Guid</NamingMethod> + <HelpTitle>SpriteLibrary</HelpTitle> + <ContentPlacement>AboveNamespaces</ContentPlacement> + </PropertyGroup> +  + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' "> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' "> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' "> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' "> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' "> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' "> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' "> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' "> + </PropertyGroup> +  + <Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" /> +  + <PropertyGroup> + <PreBuildEvent> + </PreBuildEvent> + <PostBuildEvent> + </PostBuildEvent> + <RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent> + </PropertyGroup> +</Project> \ No newline at end of file diff --git a/SpriteLibrary/Doc/forPDF.html b/SpriteLibrary/Doc/forPDF.html new file mode 100644 index 0000000..70a3fd1 --- /dev/null +++ b/SpriteLibrary/Doc/forPDF.html @@ -0,0 +1,551 @@ +<HTML> +<h2>Properties</h2> +Sprite.AnimationCount +Summary: The number of animations this sprite has +Sprite.AnimationDone +Summary: Report whether or not the animation has been completed. When you tell a Sprite to AnimateOnce, + this will report "false" until the animation sequence has been finished. At that time, the value + will be "True." The tricky bit is that this is a boolean. If you have not told a sprite to + animate once, it will always return "false." If a sprite is paused, this returns "false." The only + time this returns "true" is when you tell a sprite to animate once, or animate a few times, and those + times have completed. At that time, this will report "True". If you have a sprite with only one frame, + it may not look like it is "animating", but it is. It is simply animating that one frame over and over. + So, AnimationDone reports false, unless you have told it to animate_once. +Sprite.AnimationIndex +Summary: Get or set the animation nimber. It is best to change the animation using ChangeAnimation. + It is safer. +Sprite.AutomaticallyMoves +Summary: Determine if the sprite automatically moves (you need to give it a direction [using one of the + SetSpriteDirection functions] and speed [MovementSpeed = X] also) +Sprite.BaseImageLocation +Summary: The sprite location as found on the base image. This is usually the easiest location to use. +Sprite.Destroying +Summary: If the Sprite is in the middle of being Destroyed, this is set to true. When a Sprite is + Destroyed, it needs to erase itself and do some house-cleaning before it actually vanishes. + During this time, you may not want to use it. It is always a good thing to verify a Sprite + is not in the middle of being destroyed before you do something important with it. To Destroy + a Sprite, use the Sprite.Destroy() function. +Sprite.FrameIndex +Summary: This is the frame of the current animation sequence. +Sprite.GetSize +Summary: Return the size of the sprite in reference to the image on which it is drawn. To get the + size of the Sprite in relation to the PictureBox, use GetVisibleSize +Sprite.GetVisibleSize +Summary: Return the relative size of the Sprite in relation to the PictureBox. If the box has been + stretched or shrunk, that affects the visible size of the sprite. +Sprite.HasBeenDrawn +Summary: Report whether or not this Sprite has been drawn. If it has, then it needs to be erased at + some point in time. +Sprite.ID +Summary: The Sprite ID as specified by the sprite controller. +Sprite.MovingToPoint +Summary: Tells us if we are in the process of doing a MoveTo operation. This boolean should be the + opposite of SpriteReachedEndpoint, but that boolean is poorly named. This is usually the easier + one to use. +Sprite.Opacity +Summary: Set the opacity of the sprite. The value should be between 0 and 1. 1 is solid, 0 is transparent. +Sprite.PictureBoxLocation +Summary: The sprite location as found on the picture-box that this sprite is associated with. Used when dealing with mouse-clicks +Sprite.Rotation +Summary: Change the rotation of the sprite, using degrees. 0 degrees is to the right. 90 is up. + 180 left, 270 down. But, if your sprite was drawn facing up, then rotating it 90 degrees + will have it pointing left. The angle goes counter-clockwise. The image will be scaled + such that it continues to fit within the rectangle that it was originally in. This results + in a little bit of shrinking at times, but you should rarely notice that. +Sprite.SpriteName +Summary: The name of the sprite. Use SetSpriteName(Name) to change this name. Most Named sprites + are used to define what a sprite is. Once you have created a named sprite, you usually use + SpriteController.DuplicateSprite(Name) to clone the sprite for use. +Sprite.SpriteOriginName +Summary: Return the name of the sprite that this was duplicated from. A duplicated sprite will have + no name, but will have a SpriteOriginName. +Sprite.SpriteReachedEndPoint +Summary: This is true unless we are using MoveTo(point) or MoveTo(list of points) to tell the sprite to move + from one place to the next. This boolean tells us if it has finished or not. +Sprite.VisibleHeight +Summary: The visible Height as seen in the PictureBox. It may be stretched, or shrunk from the actual + image size. +Sprite.VisibleWidth +Summary: The visible width as seen in the PictureBox. The Sprite may be stretched or shrunk from the + actual image size. +Sprite.Zvalue +Summary: A number from 0 to 100. Default = 50. Higher numbers print on top of lower numbers. If you want a sprite to + always be drawn on top of other sprites, give it a number higher than 50. If you want a sprite to go under + other sprites, make its number lower than 50. +SpriteController.BackgroundImage +Summary: The Background Image on which the sprites are drawn. This image ends up having + sprite parts on it. The OriginalImage is the version that is clean. Use + ReplaceOriginalImage to replace the background Image. +SpriteController.OriginalImage +Summary: The Image from which the background is taken when we erase sprites. The BackgroundImage + is the image that contains images of the sprites as well as the background image. Use + ReplaceOriginalImage to replace this and the BackgroundImage. +SpriteController.SpriteCount +Summary: The count of all the sprites the controller knows about. This includes named + sprites, which may not be visible +<h2>Methods</h2> +Constructor: Animation.(SpriteLibrary.SmartImage,System.Drawing.Image,System.Int32,System.Int32,System.Int32) +Summary: Create an image from an image that has a bunch of frames in the one image. + Start at (0,0) with the specified height and width. Pull out as many images as we can +Constructor: Animation.(System.Drawing.Point,SpriteLibrary.SmartImage,System.Drawing.Image,System.Int32,System.Int32,System.Int32,System.Int32) +Summary: Create an image from an image that has a bunch of frames in the one image. + Start at the specified position (Start), and grab Count items (if we can find them) +Constructor: SmartImage.(SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32,System.Int32) +Summary: Make an animated image from an image that contains multiple frames +SmartImage.AnimationDone(System.Int32,System.Int32,System.Boolean) +Summary: Check to see if the animation is in the last frame. Only works if animateonce is set to true +SmartImage.AnimationFrameCount(System.Int32) +Summary: Return the number of frames that the specified animation has. +SmartImage.NeedsNewImage(System.Int32,System.Int32,System.TimeSpan) +Summary: Return true if the specified animation and frame for that animation needs + to be changed due to the time passing. +Constructor: Sprite.(SpriteLibrary.Sprite,System.Boolean) +Summary: Create a Sprite that is based off of the specified sprite. Clone the Sprite except that + we set SpriteName = "" and OrigSpriteName = the OldSprite.SpriteName. That way we know that + the sprite was duplicated from the original, and we can still distinguish the original from + the duplicate. +Constructor: Sprite.(SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32) +Summary: Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width and height in the image, an animation is created. +Constructor: Sprite.(SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32,System.Int32) +Summary: Generate a new sprite. It takes a width, height, and the duration in Milliseconds for each frame +Constructor: Sprite.(System.Drawing.Point,SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32,System.Int32,System.Int32) +Summary: Create a Sprite from an animation image, specifying the number of consecutive + frames to grab. +Sprite.ActuallyDraw +Summary: Actually draw the Sprite. Never use this. It is used by the SpriteController +Sprite.AddAnimation(System.Drawing.Image,System.Int32,System.Int32) +Summary: Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +Sprite.AddAnimation(System.Drawing.Image,System.Int32,System.Int32,System.Int32) +Summary: Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +Sprite.AddAnimation(System.Drawing.Point,System.Drawing.Image,System.Int32,System.Int32,System.Int32,System.Int32) +Summary: Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. +Sprite.AddAnimation(System.Int32,System.Boolean,System.Boolean) +Summary: Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand. +Sprite.AddAnimation(System.Int32,System.Int32) +Summary: Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand. +Sprite.AnimateJustAFewTimes(System.Int32,System.Int32) +Summary: Start a new animation. It will complete the animation the number of times you specify. + For example, if your sprite is walking, and one animation is one step, specifying 4 here + will result in your sprite taking 4 steps and then the animation stops. You will want + to make sure you are checking for when the animation stops, using the SpriteAnimationComplete event, + checking the Sprite.AnimationDone flag. +Sprite.AnimateOnce(System.Int32) +Summary: Start a new animation, but do it just once. You can use AnimateJustAFewTimes(1) to the same effect. + Or, you can use AnimateJustAFewTimes with a different number. The SpriteAnimationComplete event will + fire off when the animation completes. The variable, Sprite.AnimationDone will be true once the + animation finishes animating. +Sprite.CancelMoveTo +Summary: Cancel a MoveTo command. The sprite will stop moving, and all the waypoints will be removed. +Sprite.ChangeAnimation(System.Int32,System.Int32) +Summary: Start a new animation index from scratch +Sprite.ChangeAnimationSpeed(System.Int32,System.Int32) +Summary: Change the animation speed of a particular animation. This looks at the first frame + and compares that frame to the speed specified. It adjusts all the animations by the + same percentage. +Sprite.ChangeFrameAnimationSpeed(System.Int32,System.Int32,System.Int32) +Summary: Change the animation speed of a specific frame. Beware. This affects every sprite using this frame +Sprite.CheckSpriteHitsSprite(SpriteLibrary.Sprite,SpriteLibrary.SpriteCollisionMethod) +Summary: Check to see if two sprites hit each-other. The sprite collision methods are + not all programmed in. +Sprite.ConvertDegreesToRadians(System.Double) +Summary: Convert a number from degrees to radians. +Sprite.ConvertRadiansToDegrees(System.Double) +Summary: Convert a number from radians to degrees. +Sprite.Destroy +Summary: Tell the sprite to kill itself. It will erase itself and then + be removed from the spritelist. Then it will be gone forever. +Sprite.GetAnimationSpeed(System.Int32) +Summary: Return the animation speed of this particualar animation of the sprite. +Sprite.GetFrameAnimationSpeed(System.Int32,System.Int32) +Summary: Get the animation speed of a single frame. +Sprite.GetImage +Summary: return the current image frame. Warning: If you write to this image, it will + affect all sprites using this frame. +Sprite.GetImage(System.Int32,System.Int32) +Summary: return the frame for the given index. Warning: If you write to this image, it will + affect all sprites using this frame. +Sprite.GetMoveToSpritePoint(SpriteLibrary.Sprite) +Summary: Return the point that this sprite needs to be shooting for, for the center of this sprite to + hit the center of the destination sprite. +Sprite.GetSpriteBaseImageCenter +Summary: Return the centerpoint of the sprite, as found on the background image +Sprite.GetSpriteDegrees +Summary: Get the direction that the sprite is traveling in in degrees. You may want to + use Math.Round on the results. The value returned is usually just a tiny bit off + from what you set it with. For example, if you set the sprite movement direction + to be 270 degrees (down), this function may return it as 269.999992. Rounding the + number will give it back to you at probably the same direction you set it as. +Sprite.GetSpritePictureboxCenter +Summary: Return the centerpoint of the sprite, as found on the picturebox +Sprite.GetSpriteRadans +Summary: Returns the direction the sprite is currently traveling, using Radians. +Sprite.GetSpriteVector +Summary: Return the current vector that the sprite is moving along +Sprite.HideSprite +Summary: Remove the sprite from the field. This does not destroy the sprite. It simply removes it from action. + Use UnhideSprite to show it again. +Sprite.IsPaused(SpriteLibrary.SpritePauseType) +Summary: Ask if the sprite is paused using the specified sprite type (default is PauseAll) +Sprite.MoveTo(SpriteLibrary.Sprite) +Summary: Move to where the destination sprite currently is at. This is a dumb move. It does not take into + consideration the movement direction of the destination sprite. So the moving sprite does need to be + moving a bit faster than the sprite you are trying to hit for it to do so. +Sprite.MoveTo(System.Collections.Generic.List{System.Drawing.Point}) +Summary: Tell the sprite to move towards each point in turn. The sprite will move in a straight line until the first point. + From there it moves to the next point, until it has reached the last point. Every time it reaches a point, the + SpriteArrivedAtWaypoint event is triggered. When it reaches the final point in the list, the SpriteArrivedAtEndPoint + event is triggered. While the sprite is moving, the SpriteReachedEndPoint attribute is set to false. When it has + arrived, it is set to true. +Sprite.MoveTo(System.Drawing.Point) +Summary: Tell the Sprite to move towards a destination. You need to give the sprite a MovementSpeed + and tell the sprite that it can automatically move. But the sprite will begin a journey towards + that point at the MovementSpeed you have set. When it gets to the point, the SpriteArrivedAtEndPoint event + will fire off. Also, the SpriteReachedEnd bool will be true. +Sprite.NoteSpriteHitsSprite(SpriteLibrary.Sprite,SpriteLibrary.SpriteCollisionMethod) +Summary: This is used when two sprites hit each-other. +Sprite.Pause(SpriteLibrary.SpritePauseType) +Summary: Pause the sprite. We can pause just the animation (and still let it move), pause movement (and let it animate), or pause everything. +Sprite.PutBaseImageLocation(System.Double,System.Double) +Summary: Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + Unless you are using coordinates you have gotten from a mouse-click, this is how you want + to place a Sprite somewhere. It is the easiest way to track things. But, if you are + doing something using mouse-click coordinates, you want to use PutPictureBoxLocation +Sprite.PutBaseImageLocation(System.Drawing.Point) +Summary: Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + Unless you are using coordinates you have gotten from a mouse-click, this is how you want + to place a Sprite somewhere. It is the easiest way to track things. But, if you are + doing something using mouse-click coordinates, you want to use PutPictureBoxLocation +Sprite.PutPictureBoxLocation(System.Drawing.Point) +Summary: Put the Sprite at a specified location, using the dimentions of the PictureBox. + You want to use this if you got your X/Y position from a mouse-click. Otherwise, + this is the harder way to track things, particularly if your window can resize. Use + PutBaseImageLocation instead. +Sprite.RecalcPictureBoxLocation +Summary: Done when the box resizes. We need to recompute the picturebox location. The resize function + automatically calls this. You should never need to do so. +Sprite.ReplaceImage(System.Drawing.Image,System.Int32,System.Int32) +Summary: Replace a sprite image. It will replace the current frame unless you specify both an animation + and the frame within the animation you wish to replace. Warning: This replaces the image_frame + for every sprite that uses that is based off the same image. +Sprite.ReturnAdjustmentRatio +Summary: Taking into consideration how the sprite is stretched or shrunk, it + returns a SpriteAdjustmentRatio that can be used to work with the sprite + itself. +Sprite.SendToBack +Summary: Make the sprite go behind all other sprites +Sprite.SendToFront +Summary: Make the sprite show up in front of all other sprites. +Sprite.SetName(System.String) +Summary: Give this sprite a name. This way we can make a duplicate of it by specifying the name +Sprite.SetSize(System.Drawing.Size) +Summary: Resize the sprite using the base image coordinates. The width and height specified + are relative to the size of the background image, not the picturebox. +Sprite.SetSpriteDirection(System.Windows.Vector) +Summary: Set the sprite direction using a vector. The vector may contain + a speed as well as the movement delta (amount of x shift, and amount + of y shift.) If so, this function may also affect the movement speed + Most people prefer to use SetSpriteDirectionDegrees instead of using + vectors. +Sprite.SetSpriteDirectionDegrees(System.Double) +Summary: Given a "degree" (from 0 to 360, set the direction + that the sprite moves automatically. 0 is right, 90 is up, 180 is left + and 270 is down. +Sprite.SetSpriteDirectionRadians(System.Double) +Summary: Set the sprite direction using Radians. Most people do not want to use this. + Use SetSpriteDirectionDegrees instead unless you like math and know what you + are doing with Radians. +Sprite.SetSpriteDirectionToPoint(System.Drawing.Point) +Summary: Sets the Sprite Moving towards a given point. You are responsible to do something with it once it gets there. + If you want it to automatically stop upon reaching it, use MoveTo instead. Actually, the MoveTo function works + a lot better than this one. Because of integer rounding and a few other things, this function is a little + bit imprecise. If you send it towards a point, it will go in that general direction. The MoveTo function + will perpetually recalculate its way to the destination point and actually reach that point. SetSpriteDirectionToPoint + will sort-of head in the direction of the point. But MoveTo will go to that point. +Sprite.SpriteAdjustedPoint(System.Drawing.Point) +Summary: Because sprites are scaled (shrunk or stretched), this function finds the point + within the sprite that is specified by the location. this function is used by + a number of internal processes, but may be useful to you. But probably not. +Sprite.SpriteAtImagePoint(System.Drawing.Point,SpriteLibrary.SpriteCollisionMethod) +Summary: Check to see if the sprite exists at the point specified. The point given is + in coordinates used by the image (not the PictureBox, use SpriteAtPictureBox for that) +Sprite.SpriteAtPictureBoxPoint(System.Drawing.Point,SpriteLibrary.SpriteCollisionMethod) +Summary: Return true or false, asking if the specifiec sprite is at the point on the picturebox. + You can use this with a mouse-click to see if you are clicking on a sprite. Use the + SpriteCollisionMethod "transparent" to see if you have clicked on an actual pixel of the + sprite instead of just within the sprite rectangle. +Sprite.SpriteCanMoveOnImage(System.Drawing.Point) +Summary: Return true if the sprite can go to this point and still be on the drawing-board. +Sprite.SpriteCanMoveOnPictureBox(System.Drawing.Point) +Summary: Return true if the sprite can go to this point and still be on the drawing-board. +Sprite.SpriteIntersectsRectangle(System.Drawing.Rectangle) +Summary: Check to see if the specified rectangle overlaps with the sprite. +Sprite.Tick +Summary: This is run from the sprite controller every 10 miliseconds. You should never + need to call this yourself. +Sprite.UnPause(SpriteLibrary.SpritePauseType) +Summary: unpause the sprite. +Sprite.UnhideSprite +Summary: Make the sprite reappear. If you have not positioned it yet, it will show up at the top corner. It is best to only + use this when you have hidden it using HideSprite +Constructor: SpriteController.(System.Windows.Forms.PictureBox) +Summary: Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. +Constructor: SpriteController.(System.Windows.Forms.PictureBox,System.EventHandler) +Summary: Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. +SpriteController.AddSprite(SpriteLibrary.Sprite) +Summary: Add the specified sprite to the list of sprites we know about. You usually do not need to do this. + Sprites add themselves to the controller when you create a new sprite. +SpriteController.AdjustPoint(System.Drawing.Point) +Summary: Adjust an image point so that it conforms to the picturebox. +SpriteController.AdjustRectangle(System.Drawing.Rectangle) +Summary: Adjust a rectangle that is based on the image, according to the stretch of the picturebox +SpriteController.AllSprites +Summary: Return a list of all sprites +SpriteController.ChangeTickInterval(System.Int32) +Summary: Change the Tick Interval. By default, the spritecontroller does a tick every 10ms, which + is very short. Some people may prefer it to happen less regularly. Must be > 5, and less than 1001 +SpriteController.CountSpritesBasedOff(System.String) +Summary: Count the number of sprites that were duplicated from the sprite with the specified name +SpriteController.DestroyAllSprites +Summary: Remove all sprites (even named sprites that have not yet been displayed) +SpriteController.DestroySprite(SpriteLibrary.Sprite) +Summary: Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + and remove itself from the controller. After it is destroyed, it is completely gone. +SpriteController.DuplicateSprite(SpriteLibrary.Sprite) +Summary: Make a duplicate of the specified sprite. The duplicate does not yet have a location. +SpriteController.DuplicateSprite(System.String) +Summary: Find a sprite that has been named with the specified name. Then duplicate that sprite +SpriteController.Invalidate(System.Boolean) +Summary: Invalidate the entire image on which the sprites are drawn +SpriteController.Invalidate(System.Drawing.Rectangle,System.Boolean) +Summary: Invalidate a rectangle that is specified in image coordinates +SpriteController.IsKeyPressed +Summary: Check to see if any keys are pressed. +SpriteController.IsKeyPressed(System.Windows.Forms.Keys) +Summary: Check to see if the given key is pressed. +SpriteController.KeysPressed +Summary: Return a list of all the keys that are currently pressed. +SpriteController.Local_Setup +Summary: Define some things and set up some things that need defining at instantiation +SpriteController.MouseClickOnBox(System.Object,System.Windows.Forms.MouseEventArgs) +Summary: This is what happens when someone clicks on the PictureBox. We want to pass any Click events to the Sprite +SpriteController.MouseHover(System.Object,System.EventArgs) +Summary: Check to see if we are hovering over anything +SpriteController.NameSprite(SpriteLibrary.Sprite,System.String) +Summary: Find the specified Sprite in the controller and change its name to the specified string. + You can do the same thing with Sprite.SetName(Name) +SpriteController.Pause(SpriteLibrary.SpritePauseType) +Summary: Pause everything +SpriteController.PlaceSpriteBehind(SpriteLibrary.Sprite,SpriteLibrary.Sprite) +Summary: Change the display order of the sprites such that the specified sprite appears behind the other sprite. +SpriteController.PlaceSpriteInFrontOf(SpriteLibrary.Sprite,SpriteLibrary.Sprite) +Summary: Make the sprite go in front of the specified sprite. +SpriteController.PlayAsync(System.IO.Stream,System.String,System.EventHandler) +Summary: Play a sound bit in a separate thread. When the thread is done, set a bool saying that +SpriteController.ProcessImageResize(System.Object,System.EventArgs) +Summary: Process a form resize by recalculating all the picturebox locations for all sprites. +SpriteController.RegisterKeyDownFunction(SpriteLibrary.SpriteKeyEventHandler) +Summary: If you want to have a KeyDown function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +SpriteController.RegisterKeyUpFunction(SpriteLibrary.SpriteKeyEventHandler) +Summary: If you want to have a KeyUp function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) +SpriteController.ReplaceOriginalImage +Summary: Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. +SpriteController.ReplaceOriginalImage(System.Drawing.Image) +Summary: Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background +SpriteController.ResetKeypressState +Summary: Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + because a window has taken priority, or something has changed). Calling this function will reset + the stored memory of whether a key has been pressed. +SpriteController.ReturnAdjustmentRatio +Summary: Return an adjustment ratio. This is the image-size to picture-box ratio. + It is used for calculating precise pixels or picture-box locations. +SpriteController.ReturnPictureBoxAdjustedHeight(System.Int32) +Summary: Return the height of an object in picture-box terms. It is basically the virtual height + of the sprite or other item. +SpriteController.ReturnPictureBoxAdjustedPoint(System.Drawing.Point) +Summary: This does the reverse of an adjusted point. It takes a point on the image and + transforms it to one on the PictureBox +SpriteController.ReturnPictureBoxAdjustedWidth(System.Int32) +Summary: Return the width of an object in picture-box terms. It takes the width of a sprite or other + item that is being displayed on the screen, and calculates the width as displayed in the + picture-box (taking into consideration stretching or shrinking) +SpriteController.ReturnPointAdjustedForImage(System.Drawing.Point) +Summary: This takes a point, the location on a picturebox, and returns the corresponding point on the BackgroundImage. +SpriteController.SoundIsFinished(System.String) +Summary: Check to see if the specified sound has finished playing +SpriteController.SoundPlay(System.IO.Stream,System.String) +Summary: Play a sound that we can check to see if it has completed. +SpriteController.SpriteBackwards(SpriteLibrary.Sprite) +Summary: Change the display order of the specified sprite so it is more likely to go behind all other sprites. +SpriteController.SpriteForwards(SpriteLibrary.Sprite) +Summary: Change the display order of the specified sprite so it is more likely to go in front of other sprites +SpriteController.SpriteFromName(System.String) +Summary: Find a sprite that has a specified name. This returns the actual sprite with that name. + You usually want to use DuplicateSprite(Name) to clone the sprite and get one you can + destroy. If you destroy a named sprite without duplicating it, you may end up losing + it for the remainder of the program. +SpriteController.SpriteToBack(SpriteLibrary.Sprite) +Summary: Change the display order of the specified sprite so it goes behind all other sprites. +SpriteController.SpriteToFront(SpriteLibrary.Sprite) +Summary: Change the display order of the specified sprite so it goes in front of all other sprites. +SpriteController.SpritesAtImagePoint(System.Drawing.Point) +Summary: This takes a point, as as specified on the image, and returns the sprites at that point. +SpriteController.SpritesAtPoint(System.Drawing.Point) +Summary: This takes a point, as given by the mouse-click args, and returns the sprites at that point. +SpriteController.SpritesBasedOff(System.String) +Summary: Return all sprites that were based off a particular sprite name +SpriteController.SpritesBasedOffAnything +Summary: Return a list of all sprites which are not master sprites (have been based off something) +SpriteController.SpritesInImageRectangle(System.Drawing.Rectangle) +Summary: Return a list of all the sprites that intersect with the given background-image-based rectangle +SpriteController.SpritesThatHaveBeenDrawn +Summary: Return a list of all sprites which have been drawn on the image +SpriteController.TimerTick(System.Object,System.EventArgs) +Summary: The function called by the timer every 10 millisecods We also call do_tick, which + is the function defined by the user. +SpriteController.UnPause(SpriteLibrary.SpritePauseType) +Summary: un-Pause everything +<h2>Events</h2> +Sprite.CheckBeforeMove +Summary: This event fires off before a sprite is drawn. Use it if you have constraints. You + can change the location or cancel the move entirely. +Sprite.Click +Summary: This event happens when someone clicks on the sprite (on the rectangle in which the sprite is). + If you want the event to fire off only when someone clicks on the visible part of the sprite, + use ClickTransparent instead. +Sprite.ClickTransparent +Summary: This event happens when someone clicks on the sprite (on the sprite image itself). + If the sprite is sometimes hidden, but you want the click to work even if it is not + visible at that instant, use Click instead. +Sprite.MouseEnter +Summary: When the mouse moves over the sprite. Use this for a menu, when you want the menu item to glow when the + mouse is over the menu item sprite. +Sprite.MouseHover +Summary: This event happens when the mouse moves over the sprite, and then pauses. We use the hover timing from the + parent form. +Sprite.MouseLeave +Summary: When the mouse moves off the sprite. Use this for a menu, when you want the menu item to stop glowing when + the mouse moves away from the menu item sprite. +Sprite.SpriteAnimationComplete +Summary: Only used when you tell an animation to animate once. At the end of the animation, + this function fires off. +Sprite.SpriteArrivedAtEndPoint +Summary: An event for when you tell a Sprite to MoveTo(Point) a specific point, or, when you + tell the Sprite to MoveTo(list of points). When the Sprite has reached the final destination, + the Sprite fires off this event. +Sprite.SpriteArrivedAtWaypoint +Summary: When you tell a sprite to MoveTo(list of points), this fires off every time it gets to + one of the points. When it gets to the final point, only the SpriteAtEndPoint event fires off. +Sprite.SpriteBeingDestroyed +Summary: The Sprite has just been told to be destroyed. You might want to do some cleanup. + If you need to destroy some payload data, or tell something to cleanup after the sprite + this is where to do that. +Sprite.SpriteChangesAnimationFrames +Summary: When the frame of an animation changes. If you want to have something happen every time + the foot of your monster comes down, when the swing of your sword is at certain points, etc. + Check to see that the Animaton and FrameIndex are what you expect them to be. +Sprite.SpriteExitsPictureBox +Summary: This happens when the sprite has exited the picture box. Useful when you want to + keep sprites from traveling on forever after exiting. +Sprite.SpriteHitsPictureBox +Summary: This happens when the sprite hits the border of the picture-box. + Useful for when you want to have shots explode when they hit the side. +Sprite.SpriteHitsSprite +Summary: This happens when two sprites hit each-other. The SpriteEventArgs that is returned + contains the sprite that this sprite hits. +Sprite.SpriteInitializes +Summary: This event happens right after the sprite is created. Use this to immediately set a + sprite to animate once or something like that. +SpriteController.DoTick +Summary: Define a stub for an event handler that the programmer can define if they want to run + something on the tick, along with the sprite animations. +<h2>Functions</h2> +Sprite.CannotMoveOutsideBox +Summary: Determine if the sprite will automatically move outside the box. If not, it will hit the side of the box and stick +Sprite.MirrorHorizontally +Summary: Flip the image when it gets printed. If your sprite is walking left, flipping it will + make it look like it is going right. +Sprite.MirrorVertically +Summary: Flip the image when it gets printed. If your sprite looks like it is facing up, doing + this will make it look like it faces down. +Sprite.MovementSpeed +Summary: The movement speed of the sprite. To make a Sprite move, you need to set the MovementSpeed, + the direction (using SetSpriteDirection), and the AutomaticallyMoves property. +Sprite.MovingToSprite +Summary: If we are trying to collide with a sprite, we store that sprite here. +Sprite.payload +Summary: A Sprite can hold a payload. Use this to store extra information about the various Sprites. Health, Armor, + Shoot time, etc. But, to store information in the payload, you need to make a new class of SpritePayload. The syntax + for doing so is: public class TankPayload : SpritePayload { public int Armor; public int Speed; } + You can access the payload and retrieve the various values. +SpriteAdjustmentRatio.height_ratio +Summary: Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. +SpriteAdjustmentRatio.width_ratio +Summary: Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. +SpriteCollisionMethod.circle +Summary: Draws a circle (ellipse) inside the sprite rectangles and see if those ellipses overlap +SpriteCollisionMethod.rectangle +Summary: Checks if the two rectangles that contain the sprites overlap +SpriteCollisionMethod.transparency +Summary: Check to see if nontransparent portions of a sprite collide. Not working. +SpriteController.InvalidateList +Summary: This is only used by the SpriteController. It allows us to queue up invalidation requests. +SpriteController.OptimizeForLargeSpriteImages +Summary: If your sprite images need substantial growing or shrinking when displayed, you can try setting this to "true" + to see if it makes it run any faster. What it does is to resize the image once, and keep a cached copy of that + image at that size. If you use the same sprite, but with different sizes, setting this to "True" may actually slow + down the game instead of speeding it up. +SpriteController.RandomNumberGenerator +Summary: Since everything needs a random number generator, we make one that should be accessible throughout your program. +SpriteController.SpriteComparisonDelegate +Summary: Allow the sprite sort-method to be overridden. The default sprite sort method is: + SpriteComparisonDelegate = delegate (Sprite first, Sprite second) { return first.Zvalue.CompareTo(second.Zvalue); }; + Which compares just the Zvalues of the two sprites. Often you will want to have a more refined sort. The sort + order determines which sprites appear on top of other sprites. In the default state, if two sprites have the + same Zvalue, it is very uncleaer which one will draw on top of the other one. By overridding this sort function, + you can specify a very precise order of which sprite is on top and which is behind. +SpriteEventArgs.Cancel +Summary: Used primarily in the CheckBeforeMove event. If you set cancel to true, then the move fails. + You can use this to keep a Sprite from going places where it ought not to go. +SpriteEventArgs.CollisionMethod +Summary: The CollisionMethod used in the event. Currently, only rectangle collisions are used +SpriteEventArgs.NewLocation +Summary: For the CheckBeforeMove event, newlocation will be the location the sprite is trying + to move to. You can adjust the point (move it left, right, up, down) and it will affect + the placement of the sprite. +SpriteEventArgs.TargetSprite +Summary: If another Sprite is involved in the event (Collision), than that Sprite is included here. + It will be null if no other Sprite is involved. +SpritePauseType.PauseAll +Summary: All pausable things are paused. +SpritePauseType.PauseAnimation +Summary: Pause the animating. Animation resumes from the current frame when we unpause +SpritePauseType.PauseEvents +Summary: Pause events. Sprite collisions, movement checks, etc are stopped until the unpause +SpritePauseType.PauseMovement +Summary: Pause any automatic movement. Movement resumes where it was left off if you unpause +</HTML> diff --git a/SpriteLibrary/KeyMessageFilter.cs b/SpriteLibrary/KeyMessageFilter.cs new file mode 100644 index 0000000..cbc2ad6 --- /dev/null +++ b/SpriteLibrary/KeyMessageFilter.cs @@ -0,0 +1,107 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; + +namespace SpriteLibrary +{ + /// <summary> + /// This is a delegate for a keypress event. + /// </summary> + /// <param name="sender"></param> + /// <param name="e"></param> + public delegate void SpriteKeyEventHandler(object sender, KeyEventArgs e); + + /// <summary> + /// This is a system that can be used to check for any keypress on a form. It is usually used through <see cref="SpriteLibrary.SpriteController.IsKeyPressed(Keys)"/> + /// </summary> + /// <example> + /// You want to define a variable on your form, something like: + ///<code Lang="C#"> + /// private KeyMessageFilter the_filter = new KeyMessageFilter(); + ///</code> + /// When the form loads (in the <see cref="System.Windows.Forms.Form.Load"/> + /// event of the form), set the filter with: + /// <code Lang="C#"> + /// Application.AddMessageFilter(the_filter); + /// </code> + /// And then, to use it, do something like: + /// <code Lang="C#"> + /// bool Up = m_filter.IsKeyPressed(Keys.W); + /// bool Down = m_filter.IsKeyPressed(Keys.S); + /// </code> + /// Much of this code was found here: <see href="http://stackoverflow.com/questions/1100285/how-to-detect-the-currently-pressed-key"/> + /// </example> + internal class KeyMessageFilter : IMessageFilter + { + private const int WM_KEYDOWN = 0x0100; + private const int WM_KEYUP = 0x0101; + private bool m_keyPressed = false; + + + public event SpriteKeyEventHandler KeyDown = delegate { }; + public event SpriteKeyEventHandler KeyUp = delegate { }; + + private Dictionary<Keys, bool> m_keyTable = new Dictionary<Keys, bool>(); + + public Dictionary<Keys, bool> KeyTable + { + get { return m_keyTable; } + private set { m_keyTable = value; } + } + + public bool IsKeyPressed() + { + return m_keyPressed; + } + + public bool IsKeyPressed(Keys k) + { + bool pressed = false; + + if (KeyTable.TryGetValue(k, out pressed)) + { + return pressed; + } + + return false; + } + + public bool PreFilterMessage(ref Message m) + { + if (m.Msg == WM_KEYDOWN) + { + KeyTable[(Keys)m.WParam] = true; + KeyEventArgs e = new KeyEventArgs((Keys)m.WParam); + KeyDown(null, e); + m_keyPressed = true; + } + + if (m.Msg == WM_KEYUP) + { + KeyTable[(Keys)m.WParam] = false; + KeyEventArgs e = new KeyEventArgs((Keys)m.WParam); + KeyUp(null, e); + + m_keyPressed = false; + } + + return false; + } + + public List<Keys> KeysPressed() + { + var answer = KeyTable.Where(kvp => kvp.Value== true).Select(kvp => kvp.Key); + List<Keys> tList = new List<Keys>(answer); + return tList; + } + + public void ResetState() + { + foreach (Keys key in KeyTable.Keys.ToList()) + KeyTable[key] = false; + } + } +} diff --git a/SpriteLibrary/Properties/AssemblyInfo.cs b/SpriteLibrary/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..0a660d9 --- /dev/null +++ b/SpriteLibrary/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("SpriteLibrary")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("SpriteLibrary")] +[assembly: AssemblyCopyright("Copyright © 2016")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("fc04405b-2bc1-42ca-8410-a30f9baf4b6c")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Build and Revision Numbers +// by using the '*' as shown below: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.5")] +[assembly: AssemblyFileVersion("1.0.0.5")] diff --git a/SpriteLibrary/Properties/Resources.Designer.cs b/SpriteLibrary/Properties/Resources.Designer.cs new file mode 100644 index 0000000..527b3a7 --- /dev/null +++ b/SpriteLibrary/Properties/Resources.Designer.cs @@ -0,0 +1,75 @@ +//------------------------------------------------------------------------------ +// <auto-generated> +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// </auto-generated> +//------------------------------------------------------------------------------ + +namespace SpriteLibrary.Properties { + using System; + + + /// <summary> + /// A strongly-typed resource class, for looking up localized strings, etc. + /// </summary> + // This class was auto-generated by the StronglyTypedResourceBuilder + // class via a tool like ResGen or Visual Studio. + // To add or remove a member, edit your .ResX file then rerun ResGen + // with the /str option, or rebuild your VS project. + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "4.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class Resources { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Resources() { + } + + /// <summary> + /// Returns the cached ResourceManager instance used by this class. + /// </summary> + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("SpriteLibrary.Properties.Resources", typeof(Resources).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// <summary> + /// Overrides the current thread's CurrentUICulture property for all + /// resource lookups using this strongly typed resource class. + /// </summary> + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; + } + set { + resourceCulture = value; + } + } + + /// <summary> + /// Looks up a localized string similar to {\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang1033{\fonttbl{\f0\fnil\fcharset0 Calibri;}} + ///{\colortbl ;\red0\green0\blue255;} + ///{\*\generator Riched20 10.0.10586}\viewkind4\uc1 + ///\pard\sa200\sl276\slmult1\f0\fs22\lang9 This is the Running Demo, which was created to test out the SpriteController: {{\field{\*\fldinst{HYPERLINK http://www.codeproject.com/Articles/1085446/Using-Sprites-Inside-Windows-Forms }}{\fldrslt{http://www.codeproject.com/Articles/1085446/Using-Sprites-Inside-Windows-Forms\ul0\cf0}}}}\f0 [rest of string was truncated]";. + /// </summary> + internal static string ChangeLog { + get { + return ResourceManager.GetString("ChangeLog", resourceCulture); + } + } + } +} diff --git a/SpriteLibrary/Properties/Resources.resx b/SpriteLibrary/Properties/Resources.resx new file mode 100644 index 0000000..eb0b268 --- /dev/null +++ b/SpriteLibrary/Properties/Resources.resx @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="utf-8"?> +<root> +  + <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"> + <xsd:import namespace="http://www.w3.org/XML/1998/namespace" /> + <xsd:element name="root" msdata:IsDataSet="true"> + <xsd:complexType> + <xsd:choice maxOccurs="unbounded"> + <xsd:element name="metadata"> + <xsd:complexType> + <xsd:sequence> + <xsd:element name="value" type="xsd:string" minOccurs="0" /> + </xsd:sequence> + <xsd:attribute name="name" use="required" type="xsd:string" /> + <xsd:attribute name="type" type="xsd:string" /> + <xsd:attribute name="mimetype" type="xsd:string" /> + <xsd:attribute ref="xml:space" /> + </xsd:complexType> + </xsd:element> + <xsd:element name="assembly"> + <xsd:complexType> + <xsd:attribute name="alias" type="xsd:string" /> + <xsd:attribute name="name" type="xsd:string" /> + </xsd:complexType> + </xsd:element> + <xsd:element name="data"> + <xsd:complexType> + <xsd:sequence> + <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" /> + <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" /> + </xsd:sequence> + <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" /> + <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" /> + <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" /> + <xsd:attribute ref="xml:space" /> + </xsd:complexType> + </xsd:element> + <xsd:element name="resheader"> + <xsd:complexType> + <xsd:sequence> + <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" /> + </xsd:sequence> + <xsd:attribute name="name" type="xsd:string" use="required" /> + </xsd:complexType> + </xsd:element> + </xsd:choice> + </xsd:complexType> + </xsd:element> + </xsd:schema> + <resheader name="resmimetype"> + <value>text/microsoft-resx</value> + </resheader> + <resheader name="version"> + <value>2.0</value> + </resheader> + <resheader name="reader"> + <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value> + </resheader> + <resheader name="writer"> + <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value> + </resheader> + <assembly alias="System.Windows.Forms" name="System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> + <data name="ChangeLog" type="System.Resources.ResXFileRef, System.Windows.Forms"> + <value>..\Resources\ChangeLog.rtf;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;Windows-1252</value> + </data> +</root> \ No newline at end of file diff --git a/SpriteLibrary/Resources/ChangeLog.rtf b/SpriteLibrary/Resources/ChangeLog.rtf new file mode 100644 index 0000000..62304d7 --- /dev/null +++ b/SpriteLibrary/Resources/ChangeLog.rtf @@ -0,0 +1,70 @@ +{\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang1033\deflangfe1033{\fonttbl{\f0\fswiss\fprq2\fcharset0 Calibri;}{\f1\fmodern\fprq1\fcharset0 Consolas;}} +{\colortbl ;\red0\green0\blue255;\red0\green0\blue0;\red255\green255\blue255;\red43\green145\blue175;} +{\*\generator Riched20 10.0.14393}{\*\mmathPr\mdispDef1\mwrapIndent1440 }\viewkind4\uc1 +\pard\nowidctlpar\sa200\sl276\slmult1\f0\fs22\lang9 1.0.6\par +* Fized MouseEnterTransparent, MouseLeaveTransparent\par +* Added a number more Sprite creation functions\par +* Added a number more Sprite.AddAnimation functions\par +* Allow us to set the ending frame after we animate (which frame do we display when we are done) in AnimateOnce and AnimateJustAFewTimes\par +* After a ReplaceImage, it immediately invalidates the sprite and re-draws it.\par +* Add a series of Events, Sprite.MouseOverTransparent, Sprite.MouseEnterTransparent, and Sprite.MouseLeaveTransparent. These check the transparent areas of a sprite to see if you are moving over a solid or transparent area of a sprite. For use if there is a lot of empty area inside a sprite, and you do not want to trigger a MouseEnter function over the empty region.\par +1.0.5\par +* upgraded a lot of documentation. Started the big documentation push\par + - inline documentation updated\par + - Online documentation file: {{\field{\*\fldinst{HYPERLINK http://tyounglightsys.ddns.info/SpriteLibrary/doc }}{\fldrslt{http://tyounglightsys.ddns.info/SpriteLibrary/doc\ul0\cf0}}}}\f0\fs22\par + - Start of a large documentation PDF - Will not see the light of day until 1.0.6\par +* added a SpriteIsBeingDestroyed event. That way you can have code fired off as a particular sprite is being destroyed.\par +* added three events; MouseHover, MouseEnter, and MouseLeave. When the mouse moves over a sprite for the first time, it does the MouseEnter. When we move off the sprite, it does the MouseLeave, and when we pause over the sprite, it does a MouseHover.\par +* Added sprite opacity. Sprite.opacity = .5; \par +* fixed some issues with transparency and sprites\par +* Fixed my new way to add animations. The rotation they use is opposite of what I use. So everything rotated opposite from what was expected.\par +* Added Sprite.MoveTo(Sprite) so a Sprite can target another sprite. The moving sprite will probably need to be moving a bit faster than the destination sprite if the moving sprite hopes to catch up with it.\par +* Added GetSpriteBaseImageCenter and GetSpritePictureboxCenter to find the center-point of the sprite.\par +* Added SpriteComparisonDelegate, the ability to override the sort order (display order) of sprites. The sort order affects which sprite is printed on top of the other sprites. Whichever one has the highest priority is the one that appears on top of the other ones. The default sort order is created by: \cf2\highlight3\f1\fs19\lang1033 SpriteComparisonDelegate\highlight0 = \cf1\highlight3 delegate\cf2 (\cf4 Sprite\cf2 first, \cf4 Sprite\cf2 second) \{ \cf1 return\cf2 first.Zvalue.CompareTo(second.Zvalue); \}; \highlight0\par +\f0\fs22 The sort function simply compares the Zvalue. A more complex version might be:\cf0\lang9\par + +\pard\widctlpar\cf1\highlight3\f1\fs19\lang1033 delegate\cf2 (\cf4 Sprite\cf2 first, \cf4 Sprite\cf2 second) \{\par + \cf1 if\cf2 (first.Zvalue != second.Zvalue) \cf1 return\cf2 first.Zvalue.CompareTo(second.Zvalue);\par + \cf1 if\cf2 (first.BaseImageLocation.Y != second.BaseImageLocation.Y) \cf1 return\cf2 first.BaseImageLocation.Y.CompareTo(second.BaseImageLocation.Y);\par + \cf1 return\cf2 first.BaseImageLocation.X.CompareTo(second.BaseImageLocation.X);\par + +\pard\nowidctlpar\sa200\sl276\slmult1 \};\highlight0\par +\cf0\f0\fs22\lang9 * Added another way to Add Animations. We can create an animation that is a rotation of a different animation. For example, you can have something rotated by 45 or 90 degrees.\par +* Fixed a bug with large sprites that make other things blink\par +* SpriteController.ResetKeypressState() clears any residual keypress. Sometimes the program misses keys being pressed and released. This clears any memory, and starts it from scratch.\par +1.0.4\par +* fix timing issue with start-animation. It had not been setting the animation start time.\par +* Added ability to change the animation speed of one frame. Works across all sprites. \cf2\highlight3\f1\fs19 ChangeFrameAnimationSpeed\lang1033 / GetFrameAnimationSpeed\cf0\highlight0\f0\fs22\lang9\par +* Added the ability to return the count of animations this sprite has (Sprite.AnimationCount)\par +* Added a Sprite.GetImage(animation, frame) so we can retrieve any specific image\par +* added a sprite.unhidesprite function that does the opposite of the hidesprite function.\par +* Fix the getanimationspeed func to return the real amount\par +* Add a random number generator to the sprite controller\par +*Allow a change to the tick-speed. Default is 10ms.\par +*Add a spriteController.DestroyAllSprites function\par +* Added the ability to replace a sprite frame. (Sprite.ReplaceImage)\par +* Added a \cf2\highlight3\f1\fs19 RegisterKeyDownFunction\lang1033 and RegisterKeyUpFunction, as well as the corresponding events on the keyfilter. This allows you to trigger things when a key is pressed and released.\cf0\highlight0\f0\fs22\lang9\par +* Added a function to return all the sprites that intersect with a given rectangle\par +* Added a KeysPressed function that returns a list of all the keys which are currently pressed.\par +* Repaired a glitch in playing sounds. Set the stream position back to 0 (the beginning so you can play it a second time)\par +*Repaired a small bug with the animate-once function that kept rotating the animation once it had finished.\line * Support for large sprites. SpriteController.\cf2\highlight3 OptimizeForLargeSpriteImages\lang1033 = true/false will resize the sprite and store it in its resized state. It should print the sprite faster this way than if it needs to squish or expand the sprite every time it goes to print it.\par +*Add the ability to specify the starting frame when we tell the sprite to do an animation. \cf1\f1\fs19 public\cf2 \cf1 void\cf2 ChangeAnimation(\cf1 int\cf2 WhichAnimation, \cf1\b int\cf2 StartFrame = 0\b0 )\cf0\highlight0\f0\fs22\lang9\par +1.0.3\par +* Fixed a problem in the "animate a few times" function. It basically would only animate once, regardless of how many times you told it to animate.\par +* Fixed a problem in the sound. I was itterating through a list of sounds, and the list changed. My foreach loop would break. Changed that. Thanks, Warren for pointing that out.\par +* Fixed MoveTo - Occasionally the MoveTo will break terribly. If you move the sprite to the position where it is, it will make a vector with NaN (Not a Number) and it throws the sprite off to a place waaaay long away.\par +* Fixed MoveTo - Would occasionally send the sprite off in the wrong direction for a bit. The "last movement" time was not set, so, when a direction was set, it would think it had been kept from moving for some time, and leap forward that amount of time. This resulted in the sprite suddenly being half-way across the screen in a strange location. All fixed.\par +* Fixed MoveTo(List<Point>). It works much better now. It used to get a slightly off direction (probably a rounding issue) and would not recorrect. It always missed the destination. Changed it to be self correcting.\par +* FIxed faster movement to the left than right (due to dropping of decimals instead of rounding)\par +* Added this release notes file so people can figure out what has changed since the last update.\par +1.0.2\par +* Able to change animation speed\par +* Added MoveTo\par +* Added Mirroring\par +1.0.1\par +* Minor changes (DateTime.Now -> DateTime.UtcNow)\par +* Change to Payload structure. Was "Object" now it is a class of its own: SpritePayload\par +* return sprites at point broken terribly. Would return all the named sprites which had never been displayed. Finding all the sprites in the top-left corner returned a ton of sprites that should not have been there. Now it only returns sprites that have been printed.\par +1.0.0 Initial Version\par +} +� \ No newline at end of file diff --git a/SpriteLibrary/SmartImage.cs b/SpriteLibrary/SmartImage.cs new file mode 100644 index 0000000..062da55 --- /dev/null +++ b/SpriteLibrary/SmartImage.cs @@ -0,0 +1,457 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Drawing; + +namespace SpriteLibrary +{ + /// <summary> + /// A single frame of an animation + /// </summary> + internal class AnimationSingleFrame + { + public Image Frame; + public Image ResizedFrame; + public int ID; + public AnimationSingleFrame(Image SpriteImage, int id) + { + Frame = SpriteImage; + ID = id; + ResizedFrame = null; + } + } + internal class AnimationFrame + { + public int SingleFrameID; //The ID number of the image we want to view + public TimeSpan Duration; //How long does this image stay there. + public AnimationFrame(int ID, TimeSpan HowLong) + { + SingleFrameID = ID; + Duration = HowLong; + } + + } + + /// <summary> + /// One animation. A series of images. + /// </summary> + internal class Animation + { + public int AnimationID; + public List<AnimationFrame> Frames = new List<AnimationFrame>(); + + //The simplest case. It is just one image. No animation. + public Animation(SmartImage Smart_Image, Image SpriteImage) + { + //We create a new frame for it and make an animation of just one frame + AnimationID = Smart_Image.AnimationCount; + AnimationSingleFrame newSingle = new AnimationSingleFrame(SpriteImage, Smart_Image.FrameCount); + AnimationFrame newFrame = new AnimationFrame(Smart_Image.FrameCount, TimeSpan.FromMilliseconds(500)); + Frames.Add(newFrame); + Smart_Image.AddFrame(newSingle); + } + + /// <summary> + /// Create an image from an image that has a bunch of frames in the one image. + /// Start at the specified position (Start), and grab Count items (if we can find them) + /// </summary> + /// <param name="Count">The number of frames to grab</param> + /// <param name="Start">A point in the image where we start capturing frames</param> + /// <param name="Smart_Image">The smart image this is part of</param> + /// <param name="SpriteImage">the image we use for the sprite. Should have lots of images as a part of it.</param> + /// <param name="width">the width of each frame</param> + /// <param name="height">the height of each frame</param> + /// <param name="duration">The duration in miliseconds for this frame</param> + internal Animation(Point Start, SmartImage Smart_Image, Image SpriteImage, int width, int height, int duration, int Count) + { + //We create a new animation number for this new animation + AnimationID = Smart_Image.AnimationCount; + + //Now, we make new frames for each image we can find. + int x = Start.X; + int y = Start.Y; + int counter = 0; + Rectangle where; + Image newImage; + while (y + height <= SpriteImage.Height) + { + while (x + width <= SpriteImage.Width) + { + where = new Rectangle(x, y, width, height); + Bitmap tImage = (Bitmap)SpriteImage; + newImage = (Bitmap)tImage.Clone(where, tImage.PixelFormat); + AnimationSingleFrame newSingle = new AnimationSingleFrame(newImage, Smart_Image.FrameCount); + AnimationFrame newFrame = new AnimationFrame(Smart_Image.FrameCount, TimeSpan.FromMilliseconds(duration)); + Frames.Add(newFrame); + Smart_Image.AddFrame(newSingle); + x += width; + counter++; + if (counter >= Count) + return; //Stop when we have reached Count of them + } + y += height; + x = 0; + } + } + + /// <summary> + /// Create an image from an image that has a bunch of frames in the one image. + /// Start at (0,0) with the specified height and width. Pull out as many images as we can + /// </summary> + /// <param name="Smart_Image">The smart image this is part of</param> + /// <param name="SpriteImage">the image we use for the sprite. Should have lots of images as a part of it.</param> + /// <param name="width">the width of each frame</param> + /// <param name="height">the height of each frame</param> + /// <param name="duration">The duration in miliseconds for this frame</param> + internal Animation(SmartImage Smart_Image, Image SpriteImage, int width, int height, int duration) + { + //We create a new animation number for this new animation + AnimationID = Smart_Image.AnimationCount; + + //Now, we make new frames for each image we can find. + int x = 0; + int y = 0; + Rectangle where; + Image newImage; + while (y + height <= SpriteImage.Height) + { + while (x + width <= SpriteImage.Width) + { + where = new Rectangle(x, y, width, height); + Bitmap tImage = (Bitmap)SpriteImage; + newImage = (Bitmap)tImage.Clone(where, tImage.PixelFormat); + AnimationSingleFrame newSingle = new AnimationSingleFrame(newImage, Smart_Image.FrameCount); + AnimationFrame newFrame = new AnimationFrame(Smart_Image.FrameCount, TimeSpan.FromMilliseconds(duration)); + Frames.Add(newFrame); + Smart_Image.AddFrame(newSingle); + x += width; + } + y += height; + x = 0; + } + } + + internal Animation(SmartImage Smart_Image, int AnimationToCopy, bool MirrorHorizontally, bool MirrorVertically) + { + //We create a new animation number for this new animation + AnimationID = Smart_Image.AnimationCount; + + Animation One = Smart_Image.getAnimation(AnimationToCopy); + Image MeImage; + + for (int i = 0; i < One.Frames.Count; i++) + { + AnimationFrame AF = Smart_Image.GetAnimationFrame(AnimationToCopy, i); + AnimationSingleFrame ASF = Smart_Image.GetSingleFrame(AnimationToCopy, i); + MeImage = ASF.Frame; + TimeSpan Duration = AF.Duration; + Image MirrorImage = new Bitmap(MeImage); + if (MirrorHorizontally) MirrorImage.RotateFlip(RotateFlipType.RotateNoneFlipX); + if (MirrorVertically) MirrorImage.RotateFlip(RotateFlipType.RotateNoneFlipY); + //GC.Collect(); + MeImage = MirrorImage; + + AnimationSingleFrame newSingle = new AnimationSingleFrame(MeImage, Smart_Image.FrameCount); + AnimationFrame newFrame = new AnimationFrame(Smart_Image.FrameCount, Duration); + Frames.Add(newFrame); + Smart_Image.AddFrame(newSingle); + } + } + + internal Animation(SmartImage Smart_Image, int AnimationToCopy, int DegreesOfRotation) + { + //We create a new animation number for this new animation + AnimationID = Smart_Image.AnimationCount; + + GraphicsUnit tUnit = GraphicsUnit.Pixel; + Animation One = Smart_Image.getAnimation(AnimationToCopy); + Image MeImage; + + for (int i = 0; i < One.Frames.Count; i++) + { + AnimationFrame AF = Smart_Image.GetAnimationFrame(AnimationToCopy, i); + AnimationSingleFrame ASF = Smart_Image.GetSingleFrame(AnimationToCopy, i); + MeImage = ASF.Frame; + TimeSpan Duration = AF.Duration; + Image rotatedImage = new Bitmap(MeImage.Width, MeImage.Height); + using (Graphics g = Graphics.FromImage(rotatedImage)) + { + g.TranslateTransform(MeImage.Width / 2, MeImage.Height / 2); //set the rotation point as the center into the matrix + g.RotateTransform(DegreesOfRotation * -1); //rotate. The rotation direction we use is opposite of what they use + g.TranslateTransform(-MeImage.Width / 2, -MeImage.Height / 2); //restore rotation point into the matrix + g.DrawImage(MeImage, MeImage.GetBounds(ref tUnit), rotatedImage.GetBounds(ref tUnit), tUnit); //draw the image on the new bitmap + } + //GC.Collect(); + MeImage = rotatedImage; + + AnimationSingleFrame newSingle = new AnimationSingleFrame(MeImage, Smart_Image.FrameCount); + AnimationFrame newFrame = new AnimationFrame(Smart_Image.FrameCount, Duration); + Frames.Add(newFrame); + Smart_Image.AddFrame(newSingle); + } + } + + } + /// <summary> + /// This is the holder and parser for images within the AnimatedSprite world + /// It allows you to store and access animations. A smart image might be a "troll" + /// that has a series of animations for up, down, left, right, and die. + /// </summary> + internal class SmartImage + { + SpriteController MyController; + List<Animation> Animations = new List<Animation>(); + List<AnimationSingleFrame> Frames = new List<AnimationSingleFrame>(); + public int FrameCount { get { return Frames.Count; } } + public int AnimationCount { get { return Animations.Count; } } + + public SmartImage(SpriteController Controller, Image SpriteImage) + { + MyController = Controller; + AddAnimation(SpriteImage); + } + + /// <summary> + /// Make an animated image from an image that contains multiple frames + /// </summary> + /// <param name="Controller">The sprite controller this is attached to</param> + /// <param name="SpriteImage">The image we use to draw the animation from</param> + /// <param name="width">The width of the image to cut out of the main image</param> + /// <param name="height">The height of the image to cut out of the main image</param> + /// <param name="duration">The duration in miliseconds</param> + public SmartImage(SpriteController Controller, Image SpriteImage, int width, int height, int duration) + { + MyController = Controller; + AddAnimation(SpriteImage, width, height, duration); + } + public SmartImage(Point Start, SpriteController Controller, Image SpriteImage, int width, int height, int duration, int Count) + { + MyController = Controller; + AddAnimation(Start, SpriteImage, width, height, duration, Count); + } + + + public Animation getAnimation(int index) + { + if (index < 0 || index > AnimationCount) return null; + return Animations[index]; + } + + public void AddAnimation(Image SpriteImage) + { + Animation tAnimation = new Animation(this, SpriteImage); + Animations.Add(tAnimation); + } + public void AddAnimation(Image SpriteImage, int width, int height, int duration) + { + Animation tAnimation = new Animation(this, SpriteImage, width, height, duration); + Animations.Add(tAnimation); + } + public void AddAnimation(Point Start, Image SpriteImage, int width, int height, int duration, int Count) + { + Animation tAnimation = new Animation(Start, this, SpriteImage, width, height, duration, Count); + Animations.Add(tAnimation); + } + + public void AddAnimation(int AnimationToCopy, bool MirrorHorizontal, bool MirrorVertical) + { + if (AnimationToCopy < 0) return; + if (AnimationToCopy >= AnimationCount) return; + + Animation tAnimation = new Animation(this, AnimationToCopy, MirrorHorizontal, MirrorVertical); + Animations.Add(tAnimation); + } + public void AddAnimation(int AnimationToCopy, int RotationDegrees) + { + if (AnimationToCopy < 0) return; + if (AnimationToCopy >= AnimationCount) return; + Animation tAnimation = new Animation(this, AnimationToCopy, RotationDegrees); + Animations.Add(tAnimation); + } + + public void ReplaceImage(Image newimage, int animation, int frame) + { + Image SpriteImage; + if (animation >= 0 && animation < Animations.Count) + { + if (frame >= 0 && frame < Animations[animation].Frames.Count) + { + int wFrame = Animations[animation].Frames[frame].SingleFrameID; + for (int looper = 0; looper < Frames.Count; looper++) + { + if (Frames[looper].ID == wFrame) + { + SpriteImage = Frames[looper].Frame; + if (SpriteImage == null) return; + Graphics.FromImage(SpriteImage).Clear(Color.Transparent); //Erase the old image + Graphics.FromImage(SpriteImage).DrawImage(newimage, 0, 0, SpriteImage.Width, SpriteImage.Height); + Frames[looper].ResizedFrame = null; //make sure we redraw the resized frame if we need to do that. + return; //Now that we have found it, return from the loop + } + } + } + } + } + + public AnimationFrame GetAnimationFrame(int animation, int frame) + { + if (animation >= 0 && animation < Animations.Count) + { + if (frame >= 0 && frame < Animations[animation].Frames.Count) + { + return Animations[animation].Frames[frame]; + } + } + return null; + } + + public AnimationSingleFrame GetSingleFrame(int animation, int frame) + { + AnimationFrame AF = GetAnimationFrame(animation, frame); + int wFrame = AF.SingleFrameID; + for (int looper = 0; looper < Frames.Count; looper++) + { + if (Frames[looper].ID == wFrame) + return Frames[looper]; + } + return null; + } + + public Image GetImage(int animation, int frame, Size HowBig) + { + Image tImage; + bool NeedsResize = false; + //This will change. + if (animation >= 0 && animation < Animations.Count) + { + if (frame >= 0 && frame < Animations[animation].Frames.Count) + { + int wFrame = Animations[animation].Frames[frame].SingleFrameID; + for (int looper = 0; looper < Frames.Count; looper++) + { + if (Frames[looper].ID == wFrame) + { + tImage = Frames[looper].Frame; + if (!MyController.OptimizeForLargeSpriteImages) return tImage; //If we are not set to optimize, do not try to do so. + if (HowBig.Width == 0) return tImage; + if (Math.Abs(((double)tImage.Size.Width - (double)HowBig.Width) / HowBig.Width) - 1 > .3) + NeedsResize = true; + if (Math.Abs(((double)tImage.Size.Height - (double)HowBig.Height) / HowBig.Height) - 1 > .3) + NeedsResize = true; + if(NeedsResize) + { + Size newsize = new Size(HowBig.Width + (int)(HowBig.Width * .2), HowBig.Height + (int)(HowBig.Height * .2)); + if(Frames[looper].ResizedFrame == null || Frames[looper].ResizedFrame.Size != newsize) + { + Frames[looper].ResizedFrame = new Bitmap(newsize.Width, newsize.Height); + Rectangle newrec = new Rectangle(0, 0, newsize.Width, newsize.Height); + Graphics.FromImage(Frames[looper].ResizedFrame).DrawImage(tImage, newrec); + } + return Frames[looper].ResizedFrame; + } + return tImage; + } + } + } + } + return null; + } + + public TimeSpan GetCurrentDuration(int animation, int frame) + { + if (animation < 0 || animation >= Animations.Count) return new TimeSpan(); + if (frame < 0 || frame >= Animations[animation].Frames.Count) return new TimeSpan(); + return Animations[animation].Frames[frame].Duration; + } + + public void AddFrame(AnimationSingleFrame ToAdd) + { + Frames.Add(ToAdd); + } + + /// <summary> + /// Return true if the specified animation and frame for that animation needs + /// to be changed due to the time passing. + /// </summary> + /// <param name="animation">The animation index</param> + /// <param name="frame">the frame index</param> + /// <param name="duration">The time that has passed since the last frame was displayed.</param> + /// <returns></returns> + public bool NeedsNewImage(int animation, int frame, TimeSpan duration) + { + //If we do not have a valid index, return true + if (frame < 0) return true; + if (animation < 0) return true; + if (animation >= Animations.Count) return true; //Hopefully we never get here + if (frame >= Animations[animation].Frames.Count) return true; + + //If no duration is set, we never have to change it. + if (Animations[animation].Frames[frame].Duration.TotalMilliseconds == 0) + return true; + + //If we get here, we the current index is a valid one. Now, see if the timeframe needs to be changed + if (duration > Animations[animation].Frames[frame].Duration) + return true; + + //If we get here, it does not need to be changed. + return false; + } + + /// <summary> + /// Check to see if the animation is in the last frame. Only works if animateonce is set to true + /// </summary> + /// <param name="AnimateOnce">The animateOnce value of the sprite</param> + /// <param name="animation">The animation we think we are on</param> + /// <param name="frame">The frame we think we are on</param> + /// <returns></returns> + public bool AnimationDone(int animation, int frame, bool AnimateOnce) + { + if (!AnimateOnce) return false; + if (frame == Animations[animation].Frames.Count - 1) + return true; + return false; + } + + /// <summary> + /// Return the number of frames that the specified animation has. + /// </summary> + /// <param name="Animation">What animation to check</param> + /// <returns>The number of animation frames found in that animation</returns> + public int AnimationFrameCount(int Animation) + { + if (Animation < 0 || Animation >= Animations.Count) return 0; + return Animations[Animation].Frames.Count; + } + + public TimeSpan ChangeIndex(int animation, ref int frame, TimeSpan duration, bool AnimateOnce = false) + { + TimeSpan remainder = duration; + if (frame < 0) frame = 0; + if (animation < 0) return remainder; + if (animation >= Animations.Count) return remainder; //Hopefully we never get here + if (frame >= Animations[animation].Frames.Count) return remainder; + + //we have a valid index + while (remainder.TotalMilliseconds >= Animations[animation].Frames[frame].Duration.TotalMilliseconds && + Animations[animation].Frames[frame].Duration.TotalMilliseconds != 0) + { + remainder = remainder - Animations[animation].Frames[frame].Duration; + frame++; + if (AnimateOnce && frame >= Animations[animation].Frames.Count) + { + //we stay on the last frame. We also stop decrementing the timeamount. That lets us know when the last frame terminates. + frame = Animations[animation].Frames.Count - 1; + remainder = remainder + Animations[animation].Frames[frame].Duration; + return remainder; + } + else if (frame >= Animations[animation].Frames.Count) + { + frame = 0; + } + } + return remainder; + } + } +} diff --git a/SpriteLibrary/Sprite.cs b/SpriteLibrary/Sprite.cs new file mode 100644 index 0000000..a810874 --- /dev/null +++ b/SpriteLibrary/Sprite.cs @@ -0,0 +1,1897 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Drawing; +using System.Drawing.Imaging; + +namespace SpriteLibrary +{ + /// <summary> + /// An EventArgs that contains information about Sprites. Most of the Sprite events use + /// this SpriteEventArgs. + /// </summary> + public class SpriteEventArgs : EventArgs + { + /// <summary> + /// If another Sprite is involved in the event (Collision), than that Sprite is included here. + /// It will be null if no other Sprite is involved. + /// </summary> + public Sprite TargetSprite=null; + /// <summary> + /// The CollisionMethod used in the event. Currently, only rectangle collisions are used + /// </summary> + public SpriteCollisionMethod CollisionMethod = SpriteCollisionMethod.rectangle; + /// <summary> + /// For the CheckBeforeMove event, newlocation will be the location the sprite is trying + /// to move to. You can adjust the point (move it left, right, up, down) and it will affect + /// the placement of the sprite. + /// </summary> + public Point NewLocation = new Point(-1,-1); + /// <summary> + /// Used primarily in the CheckBeforeMove event. If you set cancel to true, then the move fails. + /// You can use this to keep a Sprite from going places where it ought not to go. + /// </summary> + public bool Cancel = false; + } + /// <summary> + /// A Sprite is an animated image that has a size, position, rotation, and possible vector + /// It tracks where in the animation sequence it is, can report colisions, etc. This SpriteController + /// draws, moves, and deals with most graphical aspects of the sprites for you. + /// </summary> + public class Sprite + { + int _ID = -1; + /// <summary> + /// The Sprite ID as specified by the sprite controller. + /// </summary> + public int ID { get { return _ID; } private set { _ID = value; } } + private bool SpriteHasInitialized = false; + /// <summary> + /// The name of the sprite. Use SetSpriteName(Name) to change this name. Most Named sprites + /// are used to define what a sprite is. Once you have created a named sprite, you usually use + /// <see cref="SpriteController.DuplicateSprite(String)"/> to clone the sprite for use. The basic rule of thumb is + /// to load your sprites from images once, and name the initial sprites. Then, when you go to use + /// those sprites, get duplicates of them. The reason for this is because it takes more processing time to initially + /// create the sprites than it takes to duplicate them. + /// </summary> + public string SpriteName { get; private set; } + /// <summary> + /// Set the opacity of the sprite. The value should be between 0 and 1. 1 is solid, 0 is transparent. + /// Sometimes you want to drag a sprite around the map, or show a sprite that "could be there." Setting + /// the sprite opacity is usually how you do that. One warning, however. The opacity value takes effect the + /// next time it is drawn. If the sprite is animating rapidly, it will take effect nearly emmediately. If + /// it is not animating, not moving, or just sitting there, then it may not take effect for quite some time. + /// </summary> + public float Opacity { get { return _opacity; } set { if (value <= 1 && value >= 0) _opacity = value; } } + private float _opacity = 1; + + /// <summary> + /// Return the name of the sprite that this was duplicated from. A duplicated sprite will have + /// no name, but will have a SpriteOriginName. + /// </summary> + public string SpriteOriginName { get; private set; } + SmartImage MyImage; + private double SpeedAdjust = 1; + DateTime LastResetImage = DateTime.UtcNow; + int _FrameIndex = -1; + /// <summary> + /// This is the frame of the current animation sequence. You can use this if you need to figure out what frame index + /// to resume something at, or something like that. + /// </summary> + public int FrameIndex + { + get { return _FrameIndex; } + private set { _FrameIndex = value; } + } //We start out with -1 so we know we need to draw from the begining. + int _AnimationIndex = 0; + int AnimationNumberCount = 0; + + /// <summary> + /// The final frame is the one that gets displayed once the animation has finished. + /// </summary> + private int _FinalFrameAfterAnimation = -1; + private bool SetToAnimateOnce = false; + private bool _AnimationDone = false; + /// <summary> + /// Report whether or not the animation has been completed. When you tell a Sprite to AnimateOnce, + /// this will report "false" until the animation sequence has been finished. At that time, the value + /// will be "True." The tricky bit is that this is a boolean. If you have not told a sprite to + /// animate once, it will always return "false." If a sprite is paused, this returns "false." The only + /// time this returns "true" is when you tell a sprite to animate once, or animate a few times, and those + /// times have completed. At that time, this will report "True". If you have a sprite with only one frame, + /// it may not look like it is "animating", but it is. It is simply animating that one frame over and over. + /// So, AnimationDone reports false, unless you have told it to animate_once. + /// </summary> + public bool AnimationDone { get { return _AnimationDone; } private set { _AnimationDone = value; } } + private bool ForceRedraw = false; + private bool NeedsDrawingAtEndOfTick = false; //We use this to say that we need to draw at end + private System.Windows.Vector SpriteVector; + /// <summary> + /// The movement speed of the sprite. To make a Sprite move, you need to set the MovementSpeed, + /// the direction (using + /// <see cref="SpriteLibrary.Sprite.SetSpriteDirection(System.Windows.Vector)"/>, + /// <see cref="SpriteLibrary.Sprite.SetSpriteDirectionToPoint(Point)"/>, + /// <see cref="SpriteLibrary.Sprite.SetSpriteDirectionRadians(double)"/>, + /// or <see cref="SpriteLibrary.Sprite.SetSpriteDirectionDegrees(double)"/>), and the + /// <see cref="SpriteLibrary.Sprite.AutomaticallyMoves"/> property. + /// The speed is calculated in pixels per amount of time. A higher number is faster than a lower number. + /// </summary> + public int MovementSpeed = 0; //Used in calculating when to move next. + private DateTime LastMovement = DateTime.UtcNow; + + //For tracking if we are moving along a set of points + private List<Point> MovementDestinations = new List<Point>(); + /// <summary> + /// Tells us if we are in the process of doing a MoveTo operation. This boolean should be the + /// opposite of SpriteReachedEndpoint, but that boolean is poorly named. This is usually the easier + /// one to use. + /// </summary> + public bool MovingToPoint { get { return _MovingToPoint; } private set { _MovingToPoint = value; } } + private bool _MovingToPoint = false; + + /// <summary> + /// If we are trying to collide with a sprite, we store that sprite here. + /// </summary> + private Sprite MovingToSprite = null; + + private bool _AutomaticallyMoves = false; //Does the sprite move in the direction it has been set? + /// <summary> + /// Determine if the sprite automatically moves (you need to give it a direction [using one of the + /// SetSpriteDirection functions] and speed [MovementSpeed = X] also) + /// </summary> + public bool AutomaticallyMoves + { + get { return _AutomaticallyMoves; } + set + { + _AutomaticallyMoves = value; + LastMovement = DateTime.UtcNow; + } + } + private int _Zvalue = 50; + /// <summary> + /// A number from 0 to 100. Default = 50. Higher numbers print on top of lower numbers. If you want a sprite to + /// always be drawn on top of other sprites, give it a number higher than 50. If you want a sprite to go under + /// other sprites, make its number lower than 50. + /// </summary> + public int Zvalue + { + get { return _Zvalue; } + set { _Zvalue = value; if (_Zvalue < 0) _Zvalue = 0; if (_Zvalue > 100) _Zvalue = 100; MySpriteController.SortSprites(); } + } + private bool PausedAnimation = false; + private bool PausedMovement = false; + private bool PausedEvents = false; + private DateTime PausedAnimationTime = DateTime.UtcNow; + private DateTime PausedMovementTime = DateTime.UtcNow; + /// <summary> + /// Determine if the sprite will automatically move outside the box. If not, it will hit the side of the box and stick + /// </summary> + public bool CannotMoveOutsideBox = false; //If set to true, it will not automatically move outside the picture box. + + /// <summary> + /// Get or set the animation nimber. It is best to change the animation using ChangeAnimation. + /// It is safer. + /// </summary> + public int AnimationIndex + { + get { return _AnimationIndex; } + set { if (value > -1 && value < MyImage.AnimationCount) _AnimationIndex = value; } + } + + /// <summary> + /// The number of animations this sprite has + /// </summary> + public int AnimationCount + { + get { return MyImage.AnimationCount; } + } + + //The location and size of the sprite + int xPositionOnImage = -1; + int yPositionOnImage = -1; + int xPositionOnPictureBox = -1; + int yPositionOnPictureBox = -1; + double xOnVector = -1; + double yOnVector = -1; + int Width = -1; + int Height = -1; + Rectangle MyRectangle { get { return new Rectangle(xPositionOnImage, yPositionOnImage, Width, Height); } } + bool _HasBeenDrawn = false; + /// <summary> + /// Report whether or not this Sprite has been drawn. If it has, then it needs to be erased at + /// some point in time. + /// </summary> + public bool HasBeenDrawn { get { return _HasBeenDrawn; } private set { _HasBeenDrawn = value; } } + /// <summary> + /// The sprite location as found on the base image. This is usually the easiest location to use. + /// </summary> + public Point BaseImageLocation { get { return new Point(xPositionOnImage, yPositionOnImage); } } + /// <summary> + /// The sprite location as found on the picture-box that this sprite is associated with. Used when dealing with mouse-clicks + /// </summary> + public Point PictureBoxLocation { get { return new Point(xPositionOnPictureBox, yPositionOnPictureBox); } } + /// <summary> + /// Return the size of the sprite in reference to the image on which it is drawn. To get the + /// size of the Sprite in relation to the PictureBox, use GetVisibleSize + /// </summary> + public Size GetSize { get { return new Size(Width, Height); } } + /// <summary> + /// Return the relative size of the Sprite in relation to the PictureBox. If the box has been + /// stretched or shrunk, that affects the visible size of the sprite. + /// </summary> + public Size GetVisibleSize { get { return new Size(VisibleWidth, VisibleHeight); } } + + //This is the rotation of the item. If we change this, we will draw the sprite rotated. + int _Rotation = 0; + + /// <summary> + /// Change the rotation of the sprite, using degrees. 0 degrees is to the right. 90 is up. + /// 180 left, 270 down. But, if your sprite was drawn facing up, then rotating it 90 degrees + /// will have it pointing left. The angle goes counter-clockwise. The image will be scaled + /// such that it continues to fit within the rectangle that it was originally in. This results + /// in a little bit of shrinking at times, but you should rarely notice that. + /// </summary> + public int Rotation { set { if (value >= 0 && value <= 360) _Rotation = value; } get { return _Rotation; } } + + /// <summary> + /// Flip the image when it gets printed. If your sprite is walking left, flipping it will + /// make it look like it is going right. + /// This works great for many things. But, if your program is gobbling memory or CPU, you may need to + /// consider using <see cref="SpriteLibrary.Sprite.AddAnimation(int, bool, bool)">Sprite.AddAnimation</see> + /// </summary> + public bool MirrorHorizontally = false; + + /// <summary> + /// Flip the image when it gets printed. If your sprite looks like it is facing up, doing + /// this will make it look like it faces down. + /// This works great for many things. But, if your program is gobbling memory or CPU, you may need to + /// consider using <see cref="SpriteLibrary.Sprite.AddAnimation(int, bool, bool)">Sprite.AddAnimation</see> + /// </summary> + public bool MirrorVertically = false; + + SpriteController MySpriteController; + private bool _Destroying = false; + /// <summary> + /// If the Sprite is in the middle of being Destroyed, this is set to true. When a Sprite is + /// Destroyed, it needs to erase itself and do some house-cleaning before it actually vanishes. + /// During this time, you may not want to use it. It is always a good thing to verify a Sprite + /// is not in the middle of being destroyed before you do something important with it. To Destroy + /// a Sprite, use the Sprite.Destroy() function. + /// </summary> + public bool Destroying { get { return _Destroying; } } + + /// <summary> + /// This is true unless we are using MoveTo(point) or MoveTo(list of points) to tell the sprite to move + /// from one place to the next. This boolean tells us if it has finished or not. + /// </summary> + public bool SpriteReachedEndPoint { get { return _SpriteReachedEndPoint; } internal set { _SpriteReachedEndPoint = value; } } + bool _SpriteReachedEndPoint = true; + + /// <summary> + /// The visible Height as seen in the PictureBox. It may be stretched, or shrunk from the actual + /// image size. + /// </summary> + public int VisibleHeight { get { return MySpriteController.ReturnPictureBoxAdjustedHeight(Height); } } + /// <summary> + /// The visible width as seen in the PictureBox. The Sprite may be stretched or shrunk from the + /// actual image size. + /// </summary> + public int VisibleWidth { get { return MySpriteController.ReturnPictureBoxAdjustedWidth(Width); } } + + /// <summary> + /// A Sprite can hold a payload. Use this to store extra information about the various Sprites. Health, Armor, + /// Shoot time, etc. But, to store information in the payload, you need to make a new class of SpritePayload. The syntax + /// for doing so is: + /// <code Lang="C#"> + /// public class TankPayload : SpritePayload { public int Armor; public int Speed; } + /// </code> + /// You can access the payload and retrieve the various values. + /// </summary> + public SpritePayload payload = null; //The user can put anything they want here. + //We changed the payload from being an object. The Object was too vague. By making it a defined type, + //It helps with some level of type protection. + //public object payload = null; //The user can put anything they want here. + + private List<Sprite> CollisionSprites = new List<Sprite>(); //The list of sprites that are colliding with this one + + //********************************* + //**** Add event stubs ********** + /// <summary> + /// A delegate that has a SpriteEventArgs instead of EventArgs. Used for most + /// of the Sprite events. This allows us to pass more information from sprite events than + /// a basic EventArgs allows for + /// </summary> + /// <param name="sender">The Sprite that triggers the event</param> + /// <param name="e">A SpriteEventArgs class which contains Sprite Event values</param> + public delegate void SpriteEventHandler(object sender, SpriteEventArgs e); + /// <summary> + /// This event happens right after the sprite is created. Use this to immediately set a + /// sprite to animate once or something like that. + /// </summary> + public event SpriteEventHandler SpriteInitializes = delegate { }; + /// <summary> + /// This happens when the sprite hits the border of the picture-box. + /// Useful for when you want to have shots explode when they hit the side. + /// </summary> + public event SpriteEventHandler SpriteHitsPictureBox = delegate { }; + /// <summary> + /// This happens when the sprite has exited the picture box. Useful when you want to + /// keep sprites from traveling on forever after exiting. + /// </summary> + public event SpriteEventHandler SpriteExitsPictureBox = delegate { }; + /// <summary> + /// Only used when you tell an animation to animate once. At the end of the animation, + /// this function fires off. + /// </summary> + public event SpriteEventHandler SpriteAnimationComplete = delegate { }; + /// <summary> + /// This happens when two sprites hit each-other. The SpriteEventArgs that is returned + /// contains the sprite that this sprite hits. + /// </summary> + public event SpriteEventHandler SpriteHitsSprite = delegate { }; + /// <summary> + /// This event fires off before a sprite is drawn. Use it if you have constraints. You + /// can change the location or cancel the move entirely. + /// </summary> + public event SpriteEventHandler CheckBeforeMove = delegate { }; + /// <summary> + /// This event happens when someone clicks on the sprite (on the rectangle in which the sprite is). + /// If you want the event to fire off only when someone clicks on the visible part of the sprite, + /// use ClickTransparent instead. + /// </summary> + public event SpriteEventHandler Click = delegate { }; + /// <summary> + /// This event happens when someone clicks on the sprite (on the sprite image itself). + /// If the sprite is sometimes hidden, but you want the click to work even if it is not + /// visible at that instant, use Click instead. + /// </summary> + public event SpriteEventHandler ClickTransparent = delegate { }; + /// <summary> + /// This event happens when the mouse moves over the sprite, and then pauses. We use the hover timing from the + /// parent form. + /// </summary> + public event SpriteEventHandler MouseHover = delegate { }; + /// <summary> + /// When the mouse moves over the sprite. Use this for a menu, when you want the menu item to glow when the + /// mouse is over the menu item sprite. + /// </summary> + public event SpriteEventHandler MouseEnter = delegate { }; + /// <summary> + /// When the mouse moves off the sprite. Use this for a menu, when you want the menu item to stop glowing when + /// the mouse moves away from the menu item sprite. + /// </summary> + public event SpriteEventHandler MouseLeave = delegate { }; + /// <summary> + /// This event happens when the mouse moves over a non-transparent portion of the sprite, and then pauses. + /// We use the hover timing from the parent form. + /// </summary> + public event SpriteEventHandler MouseHoverTransparent = delegate { }; + /// <summary> + /// When the mouse moves over a non-transparent portoin of the sprite. Use this for a menu, when you want the + /// menu item to glow when the mouse is over the menu item sprite. + /// </summary> + public event SpriteEventHandler MouseEnterTransparent = delegate { }; + /// <summary> + /// When the mouse moves off the non-transparent portion of the sprite. Use this for a menu, when you want the + /// menu item to stop glowing when + /// the mouse moves away from the menu item sprite. + /// </summary> + public event SpriteEventHandler MouseLeaveTransparent = delegate { }; + /// <summary> + /// When the frame of an animation changes. If you want to have something happen every time + /// the foot of your monster comes down, when the swing of your sword is at certain points, etc. + /// Check to see that the Animaton and FrameIndex are what you expect them to be. + /// </summary> + public event SpriteEventHandler SpriteChangesAnimationFrames = delegate { }; + /// <summary> + /// An event for when you tell a Sprite to MoveTo(Point) a specific point, or, when you + /// tell the Sprite to MoveTo(list of points). When the Sprite has reached the final destination, + /// the Sprite fires off this event. + /// </summary> + public event SpriteEventHandler SpriteArrivedAtEndPoint = delegate { }; + /// <summary> + /// When you tell a sprite to MoveTo(list of points), this fires off every time it gets to + /// one of the points. When it gets to the final point, only the SpriteAtEndPoint event fires off. + /// </summary> + public event SpriteEventHandler SpriteArrivedAtWaypoint = delegate { }; + + /// <summary> + /// The Sprite has just been told to be destroyed. You might want to do some cleanup. + /// If you need to destroy some payload data, or tell something to cleanup after the sprite + /// this is where to do that. + /// </summary> + public event SpriteEventHandler SpriteBeingDestroyed = delegate { }; + + + // ********************************************************** + // ************* Start of Sprite Code ********** + // ************************************* + + + /// <summary> + /// Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width + /// and height in the image, an animation is created. + /// </summary> + /// <param name="Controller">The sprite controller that manages this sprite</param> + /// <param name="SpriteImage">The image we pull the animation from</param> + /// <param name="width">The width of one animation frame</param> + /// <param name="height">The height of one animation frame</param> + public Sprite(SpriteController Controller, Image SpriteImage, int width, int height) + { + MySpriteController = Controller; + ID = MySpriteController.SpriteCount; + Width = width; + Height = height; + MyImage = new SmartImage(MySpriteController, SpriteImage); + MySpriteController.AddSprite(this); + } + + /// <summary> + /// Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width + /// and height in the image, an animation is created. + /// </summary> + /// <param name="Controller">The sprite controller that manages this sprite</param> + /// <param name="SpriteImage">The image we pull the animation from</param> + /// <param name="SpriteSize">The size of the animation frame</param> + public Sprite(SpriteController Controller, Image SpriteImage,Size SpriteSize) + { + MySpriteController = Controller; + ID = MySpriteController.SpriteCount; + Width = SpriteSize.Width; + Height = SpriteSize.Height; + MyImage = new SmartImage(MySpriteController, SpriteImage); + MySpriteController.AddSprite(this); + } + + /// <summary> + /// Generate a new single-frame sprite from the specified image. + /// </summary> + /// <param name="Controller">The sprite controller that manages this sprite</param> + /// <param name="SpriteImage">The image we pull the animation from</param> + public Sprite(SpriteController Controller, Image SpriteImage) + { + MySpriteController = Controller; + ID = MySpriteController.SpriteCount; + Width = SpriteImage.Width; + Height = SpriteImage.Height; + MyImage = new SmartImage(MySpriteController, SpriteImage); + MySpriteController.AddSprite(this); + } + /// <summary> + /// Generate a new sprite. It takes a width, height, and the duration in Milliseconds for each frame + /// </summary> + /// <param name="Controller">The sprite controller</param> + /// <param name="SpriteImage">The image we pull the animations from</param> + /// <param name="width">The width of one animation frame</param> + /// <param name="height">the height of one animation frame</param> + /// <param name="durationInMilliseconds">The number of milliseconds each frame is shown for as it animates.</param> + public Sprite(SpriteController Controller, Image SpriteImage, int width, int height, int durationInMilliseconds) + { + MySpriteController = Controller; + ID = MySpriteController.SpriteCount; + Width = width; + Height = height; + MyImage = new SmartImage(MySpriteController, SpriteImage, width, height, durationInMilliseconds); + MySpriteController.AddSprite(this); + } + /// <summary> + /// Create a Sprite from an animation image, specifying the number of consecutive + /// frames to grab. + /// </summary> + /// <param name="Start">A point on the specified image where we begin grabbing frames</param> + /// <param name="Controller">The Sprite controller we are associating the sprite with</param> + /// <param name="SpriteImage">An image that we grab the frames from</param> + /// <param name="width">The width of one frame</param> + /// <param name="height">The height of one frame</param> + /// <param name="duration">The number of milliseconds each frame is displayed for</param> + /// <param name="Count">The number of frames to grab as a part of this animation</param> + public Sprite(Point Start, SpriteController Controller, Image SpriteImage, int width, int height, int duration, int Count) + { + MySpriteController = Controller; + ID = MySpriteController.SpriteCount; + Width = width; + Height = height; + MyImage = new SmartImage(Start, MySpriteController, SpriteImage, width, height, duration, Count); + MySpriteController.AddSprite(this); + } + + /// <summary> + /// Create a Sprite that is based off of the specified sprite. Clone the Sprite except that + /// we set SpriteName = "" and OrigSpriteName = the OldSprite.SpriteName. That way we know that + /// the sprite was duplicated from the original, and we can still distinguish the original from + /// the duplicate. + /// </summary> + /// <param name="OldSprite">The Sprite to make a copy of</param> + /// <param name="RetainName">If we want to set this sprite name to be that of the original. This is a terrible idea. Never do it.</param> + public Sprite(Sprite OldSprite, bool RetainName = false) + { + MySpriteController = OldSprite.MySpriteController; + ID = MySpriteController.SpriteCount; + Width = OldSprite.Width; + Height = OldSprite.Height; + MyImage = OldSprite.MyImage; + MovementSpeed = OldSprite.MovementSpeed; + SpriteOriginName = OldSprite.SpriteName; + + //duplicate any eventhandlers we may have added to the one being cloned. + SpriteHitsPictureBox += OldSprite.SpriteHitsPictureBox; + SpriteExitsPictureBox += OldSprite.SpriteExitsPictureBox; + SpriteHitsSprite += OldSprite.SpriteHitsSprite; + SpriteAnimationComplete += OldSprite.SpriteAnimationComplete; + SpriteInitializes += OldSprite.SpriteInitializes; + CheckBeforeMove += OldSprite.CheckBeforeMove; + Click += OldSprite.Click; + ClickTransparent += OldSprite.ClickTransparent; + SpriteChangesAnimationFrames += OldSprite.SpriteChangesAnimationFrames; + SpriteArrivedAtEndPoint += OldSprite.SpriteArrivedAtEndPoint; + SpriteArrivedAtWaypoint += OldSprite.SpriteArrivedAtWaypoint; + SpriteBeingDestroyed += OldSprite.SpriteBeingDestroyed; + MouseEnter += OldSprite.MouseEnter; + MouseHover += OldSprite.MouseHover; + MouseLeave += OldSprite.MouseLeave; + + if (RetainName) + SpriteName = OldSprite.SpriteName; + MySpriteController.AddSprite(this); + } + + + // ******************* + + /// <summary> + /// Give this sprite a name. This way we can make a duplicate of it by specifying the name + /// </summary> + /// <param name="Name">A string that represents the new name of the sprite</param> + public void SetName(string Name) + { + SpriteName = Name; + } + + /// <summary> + /// Add another animation to an existing Sprite. After you add animations, you can use + /// ChangeAnimation to select which animation you want the specified sprite to show. + /// For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + /// that same guy walking right. Because we do not specify the number of frames, it starts + /// at the top-left corner and grabs as many frames as it can from the image. + /// </summary> + /// <param name="SpriteImage">The animation image to grab the frames from</param> + /// <param name="width">The width of each frame</param> + /// <param name="height">The height of each frame</param> + public void AddAnimation(Image SpriteImage, int width, int height) + { + int duration = GetAnimationSpeed(0); + MyImage.AddAnimation(SpriteImage, width, height, duration); + } + + /// <summary> + /// Add another animation to an existing Sprite. After you add animations, you can use + /// ChangeAnimation to select which animation you want the specified sprite to show. + /// For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + /// that same guy walking right. Because we do not specify the number of frames, it starts + /// at the top-left corner and grabs as many frames as it can from the image. + /// </summary> + /// <param name="SpriteImage">The animation image to grab the frames from</param> + /// <param name="SpriteSize">The size of each frame</param> + public void AddAnimation(Image SpriteImage, Size SpriteSize) + { + int duration = GetAnimationSpeed(0); + MyImage.AddAnimation(SpriteImage, SpriteSize.Width, SpriteSize.Height, duration); + } + + /// <summary> + /// Add another animation to an existing Sprite. After you add animations, you can use + /// ChangeAnimation to select which animation you want the specified sprite to show. + /// For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + /// that same guy walking right. Because we do not specify the number of frames, it starts + /// at the top-left corner and grabs as many frames as it can from the image. + /// </summary> + /// <param name="SpriteImage">The animation image to grab the frames from</param> + public void AddAnimation(Image SpriteImage) + { + int duration = GetAnimationSpeed(0); + MyImage.AddAnimation(SpriteImage, SpriteImage.Width, SpriteImage.Height, duration); + } + + /// <summary> + /// Add another animation to an existing Sprite. After you add animations, you can use + /// ChangeAnimation to select which animation you want the specified sprite to show. + /// For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + /// that same guy walking right. Because we do not specify the number of frames, it starts + /// at the top-left corner and grabs as many frames as it can from the image. + /// </summary> + /// <param name="SpriteImage">The animation image to grab the frames from</param> + /// <param name="duration">The duration the single frame uses before refreshing. 1000 is a good number.</param> + public void AddAnimation(Image SpriteImage, int duration) + { + MyImage.AddAnimation(SpriteImage, SpriteImage.Width, SpriteImage.Height, duration); + } + + + /// <summary> + /// Add another animation to an existing Sprite. After you add animations, you can use + /// ChangeAnimation to select which animation you want the specified sprite to show. + /// For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + /// that same guy walking right. Because we do not specify the number of frames, it starts + /// at the top-left corner and grabs as many frames as it can from the image. + /// </summary> + /// <param name="SpriteImage">The animation image to grab the frames from</param> + /// <param name="width">The width of each frame</param> + /// <param name="height">The height of each frame</param> + /// <param name="duration">The time in milliseconds we use for each frame</param> + public void AddAnimation(Image SpriteImage, int width, int height, int duration) + { + MyImage.AddAnimation(SpriteImage, width, height, duration); + } + + /// <summary> + /// Add another animation to an existing Sprite. After you add animations, you can use + /// ChangeAnimation to select which animation you want the specified sprite to show. + /// For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + /// that same guy walking right. Because we do not specify the number of frames, it starts + /// at the top-left corner and grabs as many frames as it can from the image. + /// </summary> + /// <param name="SpriteImage">The animation image to grab the frames from</param> + /// <param name="width">The width of each frame</param> + /// <param name="height">The height of each frame</param> + /// <param name="duration">The time in milliseconds we use for each frame</param> + /// <param name="Count">The number of frames we grab from the image</param> + /// <param name="Start">The starting position on the Image where we grab the first frame</param> + public void AddAnimation(Point Start, Image SpriteImage, int width, int height, int duration, int Count) + { + MyImage.AddAnimation(Start, SpriteImage, width, height, duration, Count); + } + + /// <summary> + /// Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + /// a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + /// rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + /// rotating it on demand. + /// </summary> + /// <param name="AnimationToCopy">An integer value specifying the animation to duplicate</param> + /// <param name="RotationDegrees">The amount of counter-clockwise rotation to add</param> + public void AddAnimation(int AnimationToCopy, int RotationDegrees) + { + if (AnimationToCopy < 0) return; + if (AnimationToCopy > MyImage.AnimationCount) return; + MyImage.AddAnimation(AnimationToCopy, RotationDegrees); + } + /// <summary> + /// Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + /// a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + /// rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + /// rotating it on demand using the <see cref="Sprite.MirrorHorizontally"/> or <see cref="Sprite.MirrorVertically"/> booleans. + /// </summary> + /// <param name="AnimationToCopy">An integer value specifying the animation to duplicate</param> + /// <param name="MirrorHorizontal">A boolean, stating if we should mirror horizontally</param> + /// <param name="MirrorVertical">A boolean, stating if we should mirror vertically</param> + public void AddAnimation(int AnimationToCopy, bool MirrorHorizontal, bool MirrorVertical) + { + if (AnimationToCopy < 0) return; + if (AnimationToCopy > MyImage.AnimationCount) return; + MyImage.AddAnimation(AnimationToCopy, MirrorHorizontal, MirrorVertical); + } + + /// <summary> + /// Start a new animation, but do it just once. You can use AnimateJustAFewTimes(1) to the same effect. + /// Or, you can use AnimateJustAFewTimes with a different number. The SpriteAnimationComplete event will + /// fire off when the animation completes. The variable, Sprite.AnimationDone will be true once the + /// animation finishes animating. + /// </summary> + /// <param name="AnimationFrameToEndOn">Once the animation has finished, display this animation frame. + /// -1, or any number that is not an actual frame, will show the last frame of the animation.</param> + /// <param name="WhichAnimation">The animation index you want to use</param> + public void AnimateOnce(int WhichAnimation, int AnimationFrameToEndOn = -1) + { + AnimateJustAFewTimes(WhichAnimation, 1); + _FinalFrameAfterAnimation = AnimationFrameToEndOn; + } + + /// <summary> + /// Start a new animation. It will complete the animation the number of times you specify. + /// For example, if your sprite is walking, and one animation is one step, specifying 4 here + /// will result in your sprite taking 4 steps and then the animation stops. You will want + /// to make sure you are checking for when the animation stops, using the SpriteAnimationComplete event, + /// checking the Sprite.AnimationDone flag. + /// </summary> + /// <param name="WhichAnimation">The animation index you want to use</param> + /// <param name="HowManyAnimations">The number of animations to do before it stops</param> + /// <param name="AnimationFrameToEndOn">Once the animation has finished, display this animation frame. + /// -1, or any number that is not an actual frame, will show the last frame of the animation.</param> + public void AnimateJustAFewTimes(int WhichAnimation, int HowManyAnimations, int AnimationFrameToEndOn = -1) + { + if (WhichAnimation > -1 && WhichAnimation < MyImage.AnimationCount) + { //We have a valid animation. Do it once + SetToAnimateOnce = true; + AnimationNumberCount = HowManyAnimations; + //Console.WriteLine("Setting to animate: " + HowManyAnimations); + AnimationDone = false; + AnimationIndex = WhichAnimation; + FrameIndex = 0; + ForceRedraw = true; + LastResetImage = DateTime.UtcNow; + _FinalFrameAfterAnimation = AnimationFrameToEndOn; + } + } + /// <summary> + /// Start a new animation index from scratch + /// </summary> + /// <param name="WhichAnimation">The animation index you want to use</param> + /// <param name="StartFrame">The first frame you want to start the animation at.</param> + public void ChangeAnimation(int WhichAnimation, int StartFrame = 0) + { + if (WhichAnimation > -1 && WhichAnimation < MyImage.AnimationCount) + { //We have a valid animation. Do it once + SetToAnimateOnce = false; + AnimationDone = false; + AnimationIndex = WhichAnimation; + FrameIndex = 0; + int NumFrames = MyImage.AnimationFrameCount(WhichAnimation); + if (StartFrame >= 0 && StartFrame <= NumFrames) + FrameIndex = StartFrame; + ForceRedraw = true; + LastResetImage = DateTime.UtcNow; //start from this second. + } + } + /// <summary> + /// Change the animation speed of a particular animation. This looks at the first frame + /// and compares that frame to the speed specified. It adjusts all the animations by the + /// same percentage. + /// </summary> + /// <param name="WhichAnimation">The integer representing the animation to change</param> + /// <param name="newSpeed">The speed in milliseconds for the new animation</param> + public void ChangeAnimationSpeed(int WhichAnimation, int newSpeed) + { + if (WhichAnimation > -1 && WhichAnimation < MyImage.AnimationCount) + { //We have a valid animation + TimeSpan CurrentTS = MyImage.GetCurrentDuration(WhichAnimation, 0); + double Current = CurrentTS.TotalMilliseconds; + double New = 1; //This is 1/2 times slower. 1 is the actual speed... + if ((int)Current != newSpeed) + { + //We have a different speed + if (Current == 0) Current = 10000; //A duration of zero should not rotate + if (newSpeed == 0) + New = 1; + else + { + New = Current / newSpeed; //We have a ratio. + } + } + //Console.WriteLine("New SpeedAdjust: " + New.ToString()); + SpeedAdjust = New; + } + } + + /// <summary> + /// Change the animation speed of a specific frame. Beware. This affects every sprite using this frame + /// </summary> + /// <param name="WhichAnimation">The index of the animation</param> + /// <param name="WhichFrame">The index of the frame within the animation</param> + /// <param name="newSpeed">The new frame duration in milliseconds</param> + public void ChangeFrameAnimationSpeed(int WhichAnimation, int WhichFrame, int newSpeed) + { + if (WhichAnimation > -1 && WhichAnimation < MyImage.AnimationCount) + { + Animation tAnimation = MyImage.getAnimation(WhichAnimation); + if (WhichFrame < 0 || WhichFrame >= tAnimation.Frames.Count) return; + tAnimation.Frames[WhichFrame].Duration = TimeSpan.FromMilliseconds(newSpeed); + } + } + + /// <summary> + /// Get the animation speed of a single frame. + /// </summary> + /// <param name="WhichAnimation">The animation we are looking at</param> + /// <param name="WhichFrame">The index of the frame we wish to get the speed of</param> + /// <returns>-1 if either index is out of range. Otherwise, return the total milliseconds of the specified frame.</returns> + public int GetFrameAnimationSpeed(int WhichAnimation, int WhichFrame) + { + if (WhichAnimation > -1 && WhichAnimation < MyImage.AnimationCount) + { + Animation tAnimation = MyImage.getAnimation(WhichAnimation); + if (WhichFrame < 0 || WhichFrame >= tAnimation.Frames.Count) return -1; + return (int)tAnimation.Frames[WhichFrame].Duration.TotalMilliseconds; + } + return -1; + } + + /// <summary> + /// Return the animation speed of this particualar animation of the sprite. + /// </summary> + /// <param name="WhichAnimation">The animation we are looking at</param> + /// <returns>The speed which was set. The speed is calculated in pixels per amount of time. A higher number is faster than a lower number</returns> + public int GetAnimationSpeed(int WhichAnimation) + { + if (WhichAnimation > -1 && WhichAnimation < MyImage.AnimationCount) + { + TimeSpan CurrentTS = MyImage.GetCurrentDuration(WhichAnimation, 0); + return (int)(CurrentTS.TotalMilliseconds / SpeedAdjust); + } + return -1; + } + private void EraseMe(bool SkipInvalidate = false) + { + EraseMe(MyRectangle.Location, SkipInvalidate); + } + private void EraseMe(Point tLocation, bool SkipInvalidate = false) + { + Image ChangedImage = MySpriteController.BackgroundImage; //This is the image itself. Changes to this affect what is displayed + Image OriginalImage = MySpriteController.OriginalImage; + System.Drawing.Rectangle oldPlace = new System.Drawing.Rectangle(tLocation.X, tLocation.Y, Width, Height); + + lock(ChangedImage) lock(OriginalImage) + { + using (Graphics gx = Graphics.FromImage(ChangedImage)) + { + gx.InterpolationMode = System.Drawing.Drawing2D.InterpolationMode.NearestNeighbor; + gx.DrawImage(OriginalImage, oldPlace, oldPlace, GraphicsUnit.Pixel); + } + } + if (!SkipInvalidate) + MySpriteController.Invalidate(oldPlace); + //Tell any sprite we overlap with that it needs to redraw + foreach (Sprite CollidesWith in CollisionSprites.ToList()) + { + CollidesWith.RedrawMeAndAllICollideWith(); + } + } + + private void RedrawMeAndAllICollideWith() + { + if (NeedsDrawingAtEndOfTick) return; //we are already doing this + NeedsDrawingAtEndOfTick = true; + //if (Opacity != 1) + EraseMe(true); + //foreach (Sprite CollidesWith in CollisionSprites) + //{ + // CollidesWith.RedrawMeAndAllICollideWith(); + //} + } + + private void DrawMe(bool SkipInvalidate = false, bool ActuallyDraw = false) + { + DrawMe(MyRectangle.Location, SkipInvalidate, ActuallyDraw); + } + private void DrawMe(Point tLocation, bool SkipInvalidate = false, bool ActuallyDraw = false) + { + if (ActuallyDraw) + { + lock(MySpriteController.BackgroundImage) + { + Image ChangedImage = MySpriteController.BackgroundImage; //This is the image itself. Changes to this affect what is displayed + System.Drawing.Rectangle ThePlace = new System.Drawing.Rectangle(tLocation.X, tLocation.Y, MyRectangle.Width, MyRectangle.Height); + + ColorMatrix matrix = new ColorMatrix(); + matrix.Matrix33 = Opacity; + ImageAttributes attributes = new ImageAttributes(); + attributes.SetColorMatrix(matrix, ColorMatrixFlag.Default, ColorAdjustType.Bitmap); + + Image MeImage = MyImage.GetImage(AnimationIndex, FrameIndex, GetVisibleSize); + if (MirrorHorizontally || MirrorVertically) + { + MeImage = (Bitmap)MeImage.Clone(); + if (MirrorHorizontally) MeImage.RotateFlip(RotateFlipType.RotateNoneFlipX); + if (MirrorVertically) MeImage.RotateFlip(RotateFlipType.RotateNoneFlipY); + } + GraphicsUnit tUnit = GraphicsUnit.Pixel; + if (Rotation != 0 && MeImage != null) + { + Image rotatedImage = new Bitmap(MeImage.Width, MeImage.Height); + using (Graphics g = Graphics.FromImage(rotatedImage)) + { + g.TranslateTransform(MeImage.Width / 2, MeImage.Height / 2); //set the rotation point as the center into the matrix + g.RotateTransform(Rotation); //rotate + g.TranslateTransform(-MeImage.Width / 2, -MeImage.Height / 2); //restore rotation point into the matrix + g.DrawImage(MeImage, MeImage.GetBounds(ref tUnit), rotatedImage.GetBounds(ref tUnit), tUnit); //draw the image on the new bitmap + + } + //GC.Collect(); + MeImage = rotatedImage; + } + if (MeImage != null) + { + //g.DrawImage(MeImage, new Rectangle(0, 0, MeImage.Width, MeImage.Height), 0, 0, rotatedImage.Width, rotatedImage.Height, tUnit, attributes); //draw the image on the new bitmap + //Graphics.FromImage(ChangedImage).DrawImage(MeImage, ThePlace, MeImage.GetBounds(ref tUnit), tUnit); + Graphics.FromImage(ChangedImage).DrawImage(MeImage, ThePlace, 0, 0, MeImage.Width, MeImage.Height, tUnit, attributes); //draw the image on the new bitmap + //Pen tmpPen = new Pen(Color.Black); + //Graphics.FromImage(ChangedImage).DrawRectangle(tmpPen, MyRectangle); + MySpriteController.Invalidate(MyRectangle); + } + NeedsDrawingAtEndOfTick = false; + } + } + else + { + NeedsDrawingAtEndOfTick = true; + } + } + + /// <summary> + /// Actually draw the Sprite. Never use this. It is used by the SpriteController + /// </summary> + internal void ActuallyDraw() + { + if (NeedsDrawingAtEndOfTick) + DrawMe(false, true); + } + + /// <summary> + /// Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + /// Unless you are using coordinates you have gotten from a mouse-click, this is how you want + /// to place a Sprite somewhere. It is the easiest way to track things. But, if you are + /// doing something using mouse-click coordinates, you want to use PutPictureBoxLocation + /// </summary> + /// <param name="NewLocationOnImage">The new point on the Image</param> + public void PutBaseImageLocation(Point NewLocationOnImage) + { + Point PointOnPictureBox = MySpriteController.ReturnPictureBoxAdjustedPoint(NewLocationOnImage); + if (MyRectangle.Location != NewLocationOnImage || !HasBeenDrawn) + { + if (HasBeenDrawn) + EraseMe(); + xPositionOnImage = NewLocationOnImage.X; + yPositionOnImage = NewLocationOnImage.Y; + xPositionOnPictureBox = PointOnPictureBox.X; + yPositionOnPictureBox = PointOnPictureBox.Y; + xOnVector = NewLocationOnImage.X; + yOnVector = NewLocationOnImage.Y; + DrawMe(NewLocationOnImage); + HasBeenDrawn = true; + } + } + /// <summary> + /// Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + /// Unless you are using coordinates you have gotten from a mouse-click, this is how you want + /// to place a Sprite somewhere. It is the easiest way to track things. But, if you are + /// doing something using mouse-click coordinates, you want to use PutPictureBoxLocation + /// </summary> + /// <param name="X">The X location on the background image</param> + /// <param name="Y">the Y location on the background image</param> + public void PutBaseImageLocation(double X, double Y) + { + Point NewLocation = new Point((int)X, (int)Y); + Point actualPoint = MySpriteController.ReturnPictureBoxAdjustedPoint(NewLocation); + if (MyRectangle.Location != NewLocation || !HasBeenDrawn) + { + if (HasBeenDrawn) + EraseMe(); + xPositionOnImage = NewLocation.X; + yPositionOnImage = NewLocation.Y; + xPositionOnPictureBox = actualPoint.X; + yPositionOnPictureBox = actualPoint.Y; + xOnVector = X; + yOnVector = Y; + DrawMe(); + HasBeenDrawn = true; + } + } + + /// <summary> + /// Put the Sprite at a specified location, using the dimentions of the PictureBox. + /// You want to use this if you got your X/Y position from a mouse-click. Otherwise, + /// this is the harder way to track things, particularly if your window can resize. Use + /// PutBaseImageLocation instead. + /// </summary> + /// <param name="NewLocationOnPictureBox">A point on the PictureBox</param> + public void PutPictureBoxLocation(Point NewLocationOnPictureBox) + { + //We adjust to the location + Point actualPoint = MySpriteController.ReturnPointAdjustedForImage(NewLocationOnPictureBox); + PutBaseImageLocation(actualPoint); + xPositionOnPictureBox = NewLocationOnPictureBox.X; + yPositionOnPictureBox = NewLocationOnPictureBox.Y; + } + + /// <summary> + /// Done when the box resizes. We need to recompute the picturebox location. The resize function + /// automatically calls this. You should never need to do so. + /// </summary> + public void RecalcPictureBoxLocation() + { + Point nPoint = MySpriteController.ReturnPictureBoxAdjustedPoint(new Point(xPositionOnImage, yPositionOnImage)); + xPositionOnPictureBox = nPoint.X; + yPositionOnPictureBox = nPoint.Y; + } + + private void SetupForDrawing() + { + //We make sure we have the correct index for the image + TimeSpan duration = DateTime.UtcNow - LastResetImage; + if (PausedAnimation) + { + TimeSpan newduration = DateTime.UtcNow - PausedAnimationTime; + LastResetImage = LastResetImage + newduration; + PausedAnimationTime = DateTime.UtcNow; + duration = DateTime.UtcNow - LastResetImage; + } + double orig = duration.TotalMilliseconds; + if (SpeedAdjust != 1) + { + double Adjust = duration.TotalMilliseconds * SpeedAdjust; + //Console.WriteLine(SpriteName + " " + SpriteOriginName + " " + orig.ToString() + " " + Adjust.ToString()); + duration = TimeSpan.FromMilliseconds(Adjust); + } + if (MyImage.NeedsNewImage(AnimationIndex, FrameIndex, duration) || ForceRedraw) + { + EraseMe(); + bool AtEnd = false; + int oldindex = FrameIndex; + if (SetToAnimateOnce && AnimationNumberCount <= 1) AtEnd = true; + //Console.Write("Changing Animation Frame: " + FrameIndex); + TimeSpan difference = MyImage.ChangeIndex(AnimationIndex, ref _FrameIndex, duration, AtEnd); + //Console.WriteLine(" To: " + FrameIndex); + SpriteChangesAnimationFrames(this, new SpriteEventArgs()); + LastResetImage = DateTime.UtcNow - difference; + if (SetToAnimateOnce) + { + if ((FrameIndex == 0 && oldindex != FrameIndex) || MyImage.AnimationDone(AnimationIndex, FrameIndex, SetToAnimateOnce)) + { + //Console.WriteLine("We are at the end frame:"); + TimeSpan HowLong = MyImage.GetCurrentDuration(AnimationIndex, FrameIndex); + if (difference > HowLong || FrameIndex == 0) + { + AnimationNumberCount--; + //Console.WriteLine("One animation done. Now we have: " + AnimationNumberCount); + if (AnimationNumberCount < 1) + { + AnimationDone = true; + if (_FinalFrameAfterAnimation >= 0 && _FinalFrameAfterAnimation < AnimationCount) + { + AnimationIndex = _FinalFrameAfterAnimation; + _FinalFrameAfterAnimation = -1; + } + if (!PausedEvents) + SpriteAnimationComplete(this, new SpriteEventArgs()); + } + } + } + } + + DrawMe(); + ForceRedraw = false; //We have done a redraw. No need to do it every time + } + } + + /// <summary> + /// This is run from the sprite controller every 10 miliseconds. You should never + /// need to call this yourself. + /// </summary> + internal void Tick() + { + if (!SpriteHasInitialized) + { + SpriteHasInitialized = true; + SpriteInitializes(this, new SpriteEventArgs()); + } + if (HasBeenDrawn) + { + SetupForDrawing(); + TryToMove(); + } + } + + /// <summary> + /// Return the point that this sprite needs to be shooting for, for the center of this sprite to + /// hit the center of the destination sprite. + /// </summary> + /// <param name="destination">The sprite we are shooting for trying to hit</param> + /// <returns>A point which allows the moving sprite to collide with the destination sprite.</returns> + private Point GetMoveToSpritePoint(Sprite destination) + { + if (destination.Destroying) return new Point(-1, -1); + Point DestCenter = destination.GetSpriteBaseImageCenter(); + Point targetPoint = new Point(DestCenter.X - Width / 2, DestCenter.Y - Height / 2); + return targetPoint; + } + + private void TryToMove() + { + if (AutomaticallyMoves && MovementSpeed > 1) + { + //Now, we move it. + //Take 1 sec and divide it by the speed. That is how many ms we need before we move + + double MS = 50 / MovementSpeed; + if (MS < 2) MS = 2; + TimeSpan Elapsed = DateTime.UtcNow - LastMovement; + if (PausedMovement) + { + TimeSpan newduration = DateTime.UtcNow - PausedMovementTime; + LastMovement = LastMovement + newduration; + PausedMovementTime = DateTime.UtcNow; + Elapsed = DateTime.UtcNow - LastMovement; + } + if (Elapsed.TotalMilliseconds > MS) + { + if(MovingToSprite != null && !MovingToSprite.Destroying) + { + MovementDestinations.Clear(); + Point TargetPoint = GetMoveToSpritePoint(MovingToSprite); + MovementDestinations.Add(TargetPoint); + } + else if(MovingToSprite != null && MovingToSprite.Destroying) + { + MovingToSprite = null; //We stop shooting for the location of the sprite. + //We are still shooting for where the sprite used to be. + } + if (MovingToPoint && MovementDestinations.Count > 0) + SetSpriteDirectionToPoint(MovementDestinations[0]); //recalculate to decrease error + double MovementDelta = Elapsed.TotalMilliseconds / MS; + double newX = xOnVector + (MovementDelta * SpriteVector.X); + double newY = yOnVector + (MovementDelta * SpriteVector.Y); + //if(double.IsNaN(newX) || newX > 1000 || newX < -1000) + //{ + // Console.WriteLine("Major issue. NAN: xOnVecor:" + xOnVector.ToString() + " MovementDelta:" + MovementDelta.ToString() + " SpriteVec:" + SpriteVector.X.ToString()); + //} + //if (double.IsNaN(newY) || newY > 1000 || newY < -1000) + //{ + // Console.WriteLine("Major issue. NAN: yOnVecor:" + yOnVector.ToString() + " MovementDelta:" + MovementDelta.ToString() + " SpriteVec:" + SpriteVector.Y.ToString()); + //} + if (CannotMoveOutsideBox) + { + double tNewx = newX; + double tNewy = newY; + Image tImage = MySpriteController.BackgroundImage; + if (newX < -1) newX = -1; + if (newY < -1) newY = -1; + if (newX > tImage.Width - Width) newX = (tImage.Width - Width) + 1; + if (newY > tImage.Height - Height) newY = (tImage.Height - Height) + 1; + if (tNewx != newX || tNewy != newY && MovingToPoint) + { + //We are not allowed to go outside the box, but our point is outside the box. Cancel + CancelMoveTo(); + } + } + SpriteEventArgs e = new SpriteEventArgs(); + e.NewLocation = new Point((int)Math.Round(newX), (int)Math.Round(newY)); + if (MovingToPoint && MovementDestinations.Count > 0) + { + //do not go past the destination point + if (SpriteVector.X < 0 && newX < MovementDestinations[0].X) newX = MovementDestinations[0].X; + if (SpriteVector.X > 0 && newX > MovementDestinations[0].X) newX = MovementDestinations[0].X; + if (SpriteVector.X == 0) newX = MovementDestinations[0].X; + if (SpriteVector.Y < 0 && newY < MovementDestinations[0].Y) newY = MovementDestinations[0].Y; + if (SpriteVector.Y > 0 && newY > MovementDestinations[0].Y) newY = MovementDestinations[0].Y; + if (SpriteVector.Y == 0) newY = MovementDestinations[0].Y; + //Check to see if we have hit the waypoint + //Console.WriteLine("Heading to: " + MovementDestinations[0].ToString() + " At: " + newX.ToString() + " " + newY.ToString()); + if ((int)newX == MovementDestinations[0].X && (int)newY == MovementDestinations[0].Y) + { + //check to see if we have hit the endpoint + MovementDestinations.RemoveAt(0); //Yank the destination + if (MovementDestinations.Count == 0) + { + CancelMoveTo(); + SpriteArrivedAtEndPoint(this, e); + } + else + { + SpriteArrivedAtWaypoint(this, e); + SetSpriteDirectionToPoint(MovementDestinations[0]); + } + } + } + else if (MovingToPoint) { + CancelMoveTo(); + } + if (!PausedEvents) + CheckBeforeMove(this, e); //See if there is any code to let us go or not go + //if(e.Cancel) + //{ + // Console.WriteLine("canceled. " + newX.ToString() + " " + newY.ToString() + " " + MovementDelta.ToString()); + //} + if (!e.Cancel) + { + //This allows our 'check before move'function to adjust the destination. + PutBaseImageLocation(e.NewLocation); + } + LastMovement = DateTime.UtcNow; + CheckForEvents(); + } + } + } + + /// <summary> + /// Resize the sprite using the base image coordinates. The width and height specified + /// are relative to the size of the background image, not the picturebox. + /// </summary> + /// <param name="NewSize">The size (width, height) to make the sprite</param> + public void SetSize(Size NewSize) + { + if (NewSize.Width == MyRectangle.Width && NewSize.Height == MyRectangle.Height) + return; //No need to do anything if we are not making changes + if (HasBeenDrawn) + { + EraseMe(); //Erase ourselves + } + Width = NewSize.Width; + Height = NewSize.Height; + if (HasBeenDrawn) + { + DrawMe(); + } + } + + /// <summary> + /// Tell the sprite to kill itself. It will erase itself and then + /// be removed from the spritelist. Then it will be gone forever. + /// </summary> + public void Destroy() + { + //If we are not already destroying ourselves + if (!_Destroying) + { + //Mark ourselves as being destroyed + _Destroying = true; + //Erase ourselves + EraseMe(); + //Remove ourselves from the controller (and the tick process) + SpriteBeingDestroyed(this, new SpriteEventArgs()); + MySpriteController.DestroySprite(this); + } + } + + /// <summary> + /// Remove the sprite from the field. This does not destroy the sprite. It simply removes it from action. + /// Use UnhideSprite to show it again. + /// </summary> + public void HideSprite() + { + EraseMe(); + HasBeenDrawn = false; + } + + + /// <summary> + /// Make the sprite reappear. If you have not positioned it yet, it will show up at the top corner. It is best to only + /// use this when you have hidden it using HideSprite + /// </summary> + public void UnhideSprite() + { + DrawMe(); + HasBeenDrawn = true; + } + /// <summary> + /// Return true or false, asking if the specifiec sprite is at the point on the picturebox. + /// You can use this with a mouse-click to see if you are clicking on a sprite. Use the + /// SpriteCollisionMethod "transparent" to see if you have clicked on an actual pixel of the + /// sprite instead of just within the sprite rectangle. + /// </summary> + /// <param name="location">The x and y location in ImageBox coordinates.</param> + /// <param name="method">The method of determining if the sprite is at that position</param> + /// <returns>True if the sprite is at the specified location, false if it is not</returns> + public bool SpriteAtPictureBoxPoint(Point location, SpriteCollisionMethod method = SpriteCollisionMethod.rectangle) + { + //Translate the position to a position on the drawing pane + SpriteAdjustmentRatio PictureBoxRatio = MySpriteController.ReturnAdjustmentRatio(); + int x = (int)(location.X / PictureBoxRatio.width_ratio); + int y = (int)(location.Y / PictureBoxRatio.height_ratio); + + //The x,y is now the pixel in the sprite. + return SpriteAtImagePoint(new Point(x, y), method); + } + + /// <summary> + /// Because sprites are scaled (shrunk or stretched), this function finds the point + /// within the sprite that is specified by the location. this function is used by + /// a number of internal processes, but may be useful to you. But probably not. + /// </summary> + /// <param name="location">A point given in Image coordinates</param> + /// <returns>A point within the pixel that can be used to find a particular pixel in a sprite.</returns> + public Point SpriteAdjustedPoint(Point location) + { + Point internalPoint = new Point(location.X - MyRectangle.Location.X, location.Y - MyRectangle.Location.Y); + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + Point AdjustedPoint = new Point((int)(internalPoint.X / Ratio.width_ratio), (int)(internalPoint.Y / Ratio.height_ratio)); + return AdjustedPoint; + } + + /// <summary> + /// Check to see if the sprite exists at the point specified. The point given is + /// in coordinates used by the image (not the PictureBox, use SpriteAtPictureBox for that) + /// </summary> + /// <param name="location">An imagebox location</param> + /// <param name="method">the method to use to determine if the image is there</param> + /// <returns>true if the sprite is at that position, false if it is not</returns> + public bool SpriteAtImagePoint(Point location, SpriteCollisionMethod method = SpriteCollisionMethod.rectangle) + { + if (location.X < MyRectangle.Location.X) return false; + if (location.X > MyRectangle.Location.X + MyRectangle.Width) return false; + if (location.Y < MyRectangle.Location.Y) return false; + if (location.Y > MyRectangle.Location.Y + MyRectangle.Height) return false; + + + //We need to adjust to the sprite being stretched or shrunk + Point internalPoint = new Point(location.X - MyRectangle.Location.X, location.Y - MyRectangle.Location.Y); + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + Point AdjustedPoint = SpriteAdjustedPoint(location); + + if (method == SpriteCollisionMethod.transparency) + { + Bitmap tImage = (Bitmap)GetImage(); + //Check the point within the sprite + if (AdjustedPoint.X < 0 || AdjustedPoint.X >= tImage.Width) return false; + if (AdjustedPoint.Y < 0 || AdjustedPoint.Y >= tImage.Height) return false; + Color OneSpace = tImage.GetPixel(AdjustedPoint.X, AdjustedPoint.Y); + if (OneSpace.A == 0) + return false; //It is transparent. No collision at this point. 255 is solid + return true; + } + if (method == SpriteCollisionMethod.circle) + { + + Point center = new Point( + MyRectangle.Width / 2, + MyRectangle.Height / 2); + + double _xRadius = MyRectangle.Width / 2; + double _yRadius = MyRectangle.Height / 2; + + + if (_xRadius <= 0.0 || _yRadius <= 0.0) + return false; + /* This is a more general form of the circle equation + * + * X^2/a^2 + Y^2/b^2 <= 1 + */ + + Point normalized = new Point(location.X - center.X, + location.Y - center.Y); + + return ((double)(normalized.X * normalized.X) + / (_xRadius * _xRadius)) + ((double)(normalized.Y * normalized.Y) / (_yRadius * _yRadius)) + <= 1.0; + } + + return true; + } + + + /// <summary> + /// return the current image frame. Warning: If you write to this image, it will + /// affect all sprites using this frame. + /// </summary> + /// <returns>An image that is the current sprite frame for the current animation</returns> + public Image GetImage() + { + if (AnimationIndex < 0) AnimationIndex = 0; + if (FrameIndex < 0) FrameIndex = 0; + return MyImage.GetImage(AnimationIndex, FrameIndex, GetVisibleSize); + } + + /// <summary> + /// return the frame for the given index. Warning: If you write to this image, it will + /// affect all sprites using this frame. + /// </summary> + /// <param name="Animation_Index">The Animation index we are trying to find</param> + /// <param name="Frame_Index">The Frame index we are trying to find</param> + /// <returns>An image that is the current sprite frame for the current animation</returns> + public Image GetImage(int Animation_Index, int Frame_Index) + { + if (Animation_Index < 0) Animation_Index = 0; + if (Animation_Index > MyImage.AnimationCount) return null; + if (Frame_Index < 0) Frame_Index = 0; + if (Frame_Index > MyImage.AnimationFrameCount(Animation_Index)) return null; + return MyImage.GetImage(Animation_Index, Frame_Index, GetVisibleSize); + } + + + /// <summary> + /// Replace a sprite image. It will replace the current frame unless you specify both an animation + /// and the frame within the animation you wish to replace. Warning: This replaces the image_frame + /// for every sprite that uses that is based off the same image. + /// </summary> + /// <param name="newimage">The new image to use</param> + /// <param name="animation">The animation you want to change</param> + /// <param name="frame">The frame within the animation you want to change</param> + public void ReplaceImage(Image newimage, int animation = -1, int frame = -1) + { + if (newimage == null) return; //do not replace it with nothing + if (AnimationIndex < 0) AnimationIndex = 0; + if (FrameIndex < 0) FrameIndex = 0; + if (animation == -1) animation = AnimationIndex; + if (frame == -1) frame = FrameIndex; + MyImage.ReplaceImage(newimage, animation, frame); + RedrawMeAndAllICollideWith(); + } + + /// <summary> + /// Taking into consideration how the sprite is stretched or shrunk, it + /// returns a SpriteAdjustmentRatio that can be used to work with the sprite + /// itself. + /// </summary> + /// <returns>The current SpriteAdjustmentRatio used to display this sprite</returns> + public SpriteAdjustmentRatio ReturnAdjustmentRatio() + { + SpriteAdjustmentRatio Ratio = new SpriteAdjustmentRatio(); + + Image tImage = GetImage(); + //if(tImage == null) Console.WriteLine(this.ID.ToString()); + Ratio.width_ratio = (double)MyRectangle.Width / (double)tImage.Width; + Ratio.height_ratio = (double)MyRectangle.Height / (double)tImage.Height; + return Ratio; + } + + /// <summary> + /// Return true if the sprite can go to this point and still be on the drawing-board. + /// </summary> + /// <param name="newpoint">The point, given in pixels and corresponding to pixels on the picturebox</param> + /// <returns>true or false</returns> + public bool SpriteCanMoveOnPictureBox(Point newpoint) + { + return SpriteCanMoveOnImage(MySpriteController.ReturnPointAdjustedForImage(newpoint)); + } + + /// <summary> + /// Return true if the sprite can go to this point and still be on the drawing-board. + /// </summary> + /// <param name="newpoint">The point, given in pixels and corresponding to pixels on the background image</param> + /// <returns>true or false</returns> + public bool SpriteCanMoveOnImage(Point newpoint) + { + Image tImage = MySpriteController.BackgroundImage; + if (newpoint.X < 0) return false; + if (newpoint.X + Width > tImage.Width) return false; + if (newpoint.Y < 0) return false; + if (newpoint.Y + Height > tImage.Height) return false; + return true; + } + + /// <summary> + /// Move to where the destination sprite currently is at. This is a dumb move. It does not take into + /// consideration the movement direction of the destination sprite. So the moving sprite does need to be + /// moving a bit faster than the sprite you are trying to hit for it to do so. + /// </summary> + /// <param name="Destination">The sprite we are trying to hit</param> + public void MoveTo(Sprite Destination) + { + MovingToSprite = Destination; + LastMovement = DateTime.UtcNow; + MovementDestinations.Clear(); + Point TargetPoint = GetMoveToSpritePoint(Destination); + MovementDestinations.Add(TargetPoint); + MovingToPoint = true; + SpriteReachedEndPoint = false; + SetSpriteDirectionToPoint(TargetPoint); + } + + /// <summary> + /// Tell the Sprite to move towards a destination. You need to give the sprite a MovementSpeed + /// and tell the sprite that it can automatically move. But the sprite will begin a journey towards + /// that point at the MovementSpeed you have set. When it gets to the point, the SpriteArrivedAtEndPoint event + /// will fire off. Also, the SpriteReachedEnd bool will be true. + /// </summary> + /// <param name="Destination">An image-point that the sprite will move to.</param> + public void MoveTo(Point Destination) + { + List<Point> tList = new List<Point>(); + tList.Add(Destination); + MoveTo(tList); //This way we only have one function to make. + } + + /// <summary> + /// Tell the sprite to move towards each point in turn. The sprite will move in a straight line until the first point. + /// From there it moves to the next point, until it has reached the last point. Every time it reaches a point, the + /// SpriteArrivedAtWaypoint event is triggered. When it reaches the final point in the list, the SpriteArrivedAtEndPoint + /// event is triggered. While the sprite is moving, the SpriteReachedEndPoint attribute is set to false. When it has + /// arrived, it is set to true. + /// </summary> + /// <param name="DestinationList">A list of Image-Points that the sprite will follow, one after the other</param> + public void MoveTo(List<Point> DestinationList) + { + MovingToSprite = null; //If we were trying to hit something, we are no longer trying to hit it. + LastMovement = DateTime.UtcNow; + if (DestinationList.Count == 0) CancelMoveTo(); //If we tell it to move nowhere, cancel it + MovementDestinations.Clear(); + foreach(Point one in DestinationList) + MovementDestinations.Add(one); + MovingToPoint = true; + SpriteReachedEndPoint = false; + SetSpriteDirectionToPoint(DestinationList[0]); + } + + /// <summary> + /// Sets the Sprite Moving towards a given point. You are responsible to do something with it once it gets there. + /// If you want it to automatically stop upon reaching it, use MoveTo instead. Actually, the MoveTo function works + /// a lot better than this one. Because of integer rounding and a few other things, this function is a little + /// bit imprecise. If you send it towards a point, it will go in that general direction. The MoveTo function + /// will perpetually recalculate its way to the destination point and actually reach that point. SetSpriteDirectionToPoint + /// will sort-of head in the direction of the point. But MoveTo will go to that point. + /// </summary> + /// <param name="ImagePointDestination">The destination, based off a point on the background image, that we send the sprite towards.</param> + public void SetSpriteDirectionToPoint(Point ImagePointDestination) + { + double x = ImagePointDestination.X - xPositionOnImage; + double y = ImagePointDestination.Y - yPositionOnImage; + double distance = Math.Sqrt(x *x + y * y); + if (distance == 0) return; //No need to go anywhere. + System.Windows.Vector newVec = new System.Windows.Vector(x / distance, y / distance); + //if(double.IsNaN(newVec.X) || double.IsNaN(newVec.Y)) + //{ + // Console.WriteLine("SetSpriteDirectionToPoint: Creating invalid vector " + distance); + //} + SetSpriteDirection(newVec); + //Console.WriteLine("SetDirectionToPoint " + ImagePointDestination.ToString()); + } + + /// <summary> + /// Cancel a MoveTo command. The sprite will stop moving, and all the waypoints will be removed. + /// </summary> + public void CancelMoveTo() + { + SpriteReachedEndPoint = true; + MovementDestinations.Clear(); + MovingToSprite = null; //If we were heading towards a sprite. Stop doing so. + if (!MovingToPoint) return; //We do not do anything if we are not moving. + MovementSpeed = 0; + //AutomaticallyMoves = false; + SetSpriteDirectionDegrees(0);//Basically reset it to nothing + MovingToPoint = false; + } + + /// <summary> + /// Given a "degree" (from 0 to 360, set the direction + /// that the sprite moves automatically. 0 is right, 90 is up, 180 is left + /// and 270 is down. + /// </summary> + /// <param name="AngleInDegrees">the degrees to use</param> + public void SetSpriteDirectionDegrees(double AngleInDegrees) + { + //convert to Radians and set it with that + double Radians = ConvertDegreesToRadians(AngleInDegrees); + SetSpriteDirectionRadians(Radians); + } + + /// <summary> + /// Set the sprite direction using Radians. Most people do not want to use this. + /// Use SetSpriteDirectionDegrees instead unless you like math and know what you + /// are doing with Radians. + /// </summary> + /// <param name="AngleInRadians">The angle in radians</param> + public void SetSpriteDirectionRadians(double AngleInRadians) + { + //Turn it into a vector + System.Windows.Vector newVector = new System.Windows.Vector((float)Math.Cos(AngleInRadians), + -(float)Math.Sin(AngleInRadians)); + SetSpriteDirection(newVector); + } + + /// <summary> + /// Set the sprite direction using a vector. The vector may contain + /// a speed as well as the movement delta (amount of x shift, and amount + /// of y shift.) If so, this function may also affect the movement speed + /// Most people prefer to use SetSpriteDirectionDegrees instead of using + /// vectors. + /// </summary> + /// <param name="newVector">A vector</param> + public void SetSpriteDirection(System.Windows.Vector newVector) + { + System.Windows.Vector oldVector = newVector; + //use the specified vector + if (Math.Round(newVector.Length) != 1) + { + double NewSpeed = Math.Round(newVector.Length); + MovementSpeed = (int)NewSpeed; + } + newVector.Normalize(); + if (double.IsNaN(newVector.X) || double.IsNaN(newVector.Y)) + { + //Console.WriteLine("SetSpriteDirection: Error setting direction. " + oldVector.ToString()); + newVector = oldVector; + } + SpriteVector = newVector; + } + + /// <summary> + /// Convert a number from degrees to radians. + /// </summary> + /// <param name="Degrees">The number from 0 to 360 in degrees</param> + /// <returns>The corresponding number converted to radians</returns> + public double ConvertDegreesToRadians(double Degrees) + { + return (Math.PI / 180.0) * Degrees; + } + + /// <summary> + /// Convert a number from radians to degrees. + /// </summary> + /// <param name="Radians">The number of radians</param> + /// <returns>The corresponding number in degrees</returns> + public double ConvertRadiansToDegrees(double Radians) + { + double degrees = (180.0 / Math.PI) * Radians; + if (Radians < 0) degrees += 360; + return degrees; + } + + /// <summary> + /// Return the current vector that the sprite is moving along + /// </summary> + /// <returns>The current sprite vector</returns> + public System.Windows.Vector GetSpriteVector() + { + return SpriteVector; + } + + /// <summary> + /// Returns the direction the sprite is currently traveling, using Radians. + /// </summary> + /// <returns>The direction in radians that the sprite is traveling in</returns> + public double GetSpriteRadans() + { + //double radians = Math.Atan2((double)SpriteVector.Y, (double)SpriteVector.X); + double radians; + if(SpriteVector.Y > 0 && SpriteVector.X > 0) + { + //calculate it in the other quadrant and then adjust. + radians = Math.Atan2((double)SpriteVector.Y, (double)SpriteVector.X); + radians = (2 * Math.PI) - radians; + } + else + radians = Math.Atan2(-(double)SpriteVector.Y, (double)SpriteVector.X); + return radians; + } + + /// <summary> + /// Get the direction that the sprite is traveling in in degrees. You may want to + /// use Math.Round on the results. The value returned is usually just a tiny bit off + /// from what you set it with. For example, if you set the sprite movement direction + /// to be 270 degrees (down), this function may return it as 269.999992. Rounding the + /// number will give it back to you at probably the same direction you set it as. + /// </summary> + /// <returns>A double (it has a decimal place) that represents the direction in degrees</returns> + public double GetSpriteDegrees() + { + double radians = GetSpriteRadans(); + double degrees = ConvertRadiansToDegrees(radians); + if (degrees < 0) degrees = 360 + degrees; + return degrees; + } + + /// <summary> + /// Return the centerpoint of the sprite, as found on the background image + /// </summary> + /// <returns>a point with the x and y based off the background image location</returns> + public Point GetSpriteBaseImageCenter() + { + Point corner = BaseImageLocation; + return new Point(corner.X + Width / 2, corner.Y + Height / 2); + } + + /// <summary> + /// Return the centerpoint of the sprite, as found on the picturebox + /// </summary> + /// <returns>A point with the x and y found on the picturebox</returns> + public Point GetSpritePictureboxCenter() + { + Point corner = PictureBoxLocation; + return new Point(corner.X + VisibleWidth / 2, corner.Y + VisibleHeight / 2); + } + + // ***************** Events *********** + private bool CheckForHittingEdgeOfImage() + { + Image tImage = MySpriteController.BackgroundImage; + bool outOfBounds = false; + if (xPositionOnImage < 0) outOfBounds = true; + if (xPositionOnImage + Width > tImage.Width) outOfBounds = true; + if (yPositionOnImage < 0) outOfBounds = true; + if (yPositionOnImage + Height > tImage.Height) outOfBounds = true; + if (outOfBounds) + { + if (!PausedEvents) + SpriteHitsPictureBox(this, new SpriteEventArgs()); + } + return outOfBounds; + } + private bool CheckForExitingImage() + { + Image tImage = MySpriteController.BackgroundImage; + bool outOfBounds = false; + if (xPositionOnImage + Width < 0) outOfBounds = true; + if (xPositionOnImage > tImage.Width) outOfBounds = true; + if (yPositionOnImage + Width < 0) outOfBounds = true; + if (yPositionOnImage > tImage.Height) outOfBounds = true; + if (outOfBounds) + { + if (!PausedEvents) + SpriteExitsPictureBox(this, new SpriteEventArgs()); + } + return outOfBounds; + } + + private bool CheckToSeeIfSpriteHitsSprite(Sprite target, SpriteCollisionMethod how) + { + if (target == this) return false; //We do not collide with ourselves. + if (target.xPositionOnImage + target.Width < xPositionOnImage) return false; + if (target.xPositionOnImage > xPositionOnImage + Width) return false; + if (target.yPositionOnImage + target.Height < yPositionOnImage) return false; + if (target.yPositionOnImage > yPositionOnImage + Height) return false; + //If we get here, we have two rectangles ovelapping. + if (how == SpriteCollisionMethod.circle) + { + + } + if (how == SpriteCollisionMethod.transparency) + { + + } + return true; + } + + /// <summary> + /// Check to see if the specified rectangle overlaps with the sprite. + /// </summary> + /// <param name="target">The rectangle we are looking to see if we hit</param> + /// <returns>True if the rectangle overlaps the sprite rectabgle</returns> + public bool SpriteIntersectsRectangle(Rectangle target) + { + if (target.X + target.Width < xPositionOnImage) return false; + if (target.X > xPositionOnImage + Width) return false; + if (target.Y + target.Height < yPositionOnImage) return false; + if (target.Y > yPositionOnImage + Height) return false; + //If we get here, we have two rectangles ovelapping. + return true; + } + + /// <summary> + /// Check to see if two sprites hit each-other. The sprite collision methods are + /// not all programmed in. + /// </summary> + /// <param name="target">The Sprite we are checking to see if we hit</param> + /// <param name="how">The method we use to determine if they hit</param> + public void CheckSpriteHitsSprite(Sprite target, SpriteCollisionMethod how) + { + if (target == this) return; + if (CheckToSeeIfSpriteHitsSprite(target, how)) + { + target.NoteSpriteHitsSprite(this, how); + NoteSpriteHitsSprite(target, how); + CollisionSprites.Add(target); + } + } + + /// <summary> + /// This is used when two sprites hit each-other. + /// </summary> + /// <param name="target">The sprite it hits</param> + /// <param name="how">the method for checking</param> + internal void NoteSpriteHitsSprite(Sprite target, SpriteCollisionMethod how) + { + if (target == this) return; + SpriteEventArgs newArgs = new SpriteEventArgs(); + newArgs.TargetSprite = target; + newArgs.CollisionMethod = how; + if (SpriteHitsSprite != null) + { + if (!PausedEvents) + SpriteHitsSprite(this, newArgs); + } + } + + internal void CheckForEvents() + { + if (!CheckForExitingImage()) + { + CheckForHittingEdgeOfImage(); + } + } + + internal void ClearCollisionList() + { + CollisionSprites.Clear(); + } + + /// <summary> + /// Make the sprite show up in front of all other sprites. + /// </summary> + public void SendToFront() + { + MySpriteController.SpriteToFront(this); + } + + /// <summary> + /// Make the sprite go behind all other sprites + /// </summary> + public void SendToBack() + { + MySpriteController.SpriteToBack(this); + } + + /// <summary> + /// Pause the sprite. We can pause just the animation (and still let it move), pause movement (and let it animate), or pause everything. + /// </summary> + /// <param name="What">Which aspects of the sprite you want to pause.</param> + public void Pause(SpritePauseType What = SpritePauseType.PauseAll) + { + if(!PausedAnimation && (What == SpritePauseType.PauseAnimation || What == SpritePauseType.PauseAll)) + { + PausedAnimationTime = DateTime.UtcNow; + PausedAnimation = true; + } + if (!PausedMovement && ( What == SpritePauseType.PauseMovement || What == SpritePauseType.PauseAll)) + { + PausedMovementTime = DateTime.UtcNow; + PausedMovement = true; + } + if (What == SpritePauseType.PauseEvents || What == SpritePauseType.PauseAll) + { + PausedEvents = true; + } + } + /// <summary> + /// unpause the sprite. + /// </summary> + /// <param name="What">Which aspects of the sprite you want to unpause.</param> + public void UnPause(SpritePauseType What = SpritePauseType.PauseAll) + { + TimeSpan duration; + if (PausedAnimation && What == SpritePauseType.PauseAnimation || What == SpritePauseType.PauseAll) + { + duration = DateTime.UtcNow - PausedAnimationTime; + LastResetImage = LastResetImage + duration; + PausedAnimation = false; + } + if (PausedMovement && What == SpritePauseType.PauseMovement || What == SpritePauseType.PauseAll) + { + duration = DateTime.UtcNow - PausedMovementTime; + LastMovement = LastResetImage + duration; + PausedMovement = false; + } + if (PausedEvents && What == SpritePauseType.PauseEvents || What == SpritePauseType.PauseAll) + { + PausedEvents = false; + } + } + /// <summary> + /// Ask if the sprite is paused using the specified sprite type (default is PauseAll) + /// </summary> + /// <param name="What">The spritePauseType to see if the sprite is paused with</param> + /// <returns>True if the sprite is set to pause the specified item, false if not</returns> + public bool IsPaused(SpritePauseType What = SpritePauseType.PauseAll) + { + if (What == SpritePauseType.PauseAnimation && PausedAnimation) return true; + if (What == SpritePauseType.PauseMovement && PausedMovement) return true; + if (What == SpritePauseType.PauseEvents && PausedMovement) return true; + if (What == SpritePauseType.PauseAll && PausedAnimation && PausedMovement && PausedEvents) return true; + return false; + } + + internal void ClickedOn(SpriteCollisionMethod how) + { + if (how == SpriteCollisionMethod.rectangle) + Click(this, new SpriteEventArgs()); + if (how == SpriteCollisionMethod.transparency) + ClickTransparent(this, new SpriteEventArgs()); + } + + internal void HoverOver() + { + MouseHover(this, new SpriteEventArgs()); + } + internal void Enter() + { + MouseEnter(this, new SpriteEventArgs()); + } + internal void Leave() + { + MouseLeave(this, new SpriteEventArgs()); + } + + internal void HoverOverTransparent() + { + MouseHoverTransparent(this, new SpriteEventArgs()); + } + internal void EnterTransparent() + { + MouseEnterTransparent(this, new SpriteEventArgs()); + } + internal void LeaveTransparent() + { + MouseLeaveTransparent(this, new SpriteEventArgs()); + } + } +} diff --git a/SpriteLibrary/SpriteController.cs b/SpriteLibrary/SpriteController.cs new file mode 100644 index 0000000..6092469 --- /dev/null +++ b/SpriteLibrary/SpriteController.cs @@ -0,0 +1,1364 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Threading; +using System.ComponentModel; +using System.Drawing; +using System.Windows.Forms; +using System.IO; +using System.IO.Packaging; + +namespace SpriteLibrary +{ + /// <summary> + /// SpriteLibrary is a .net graphical library for creating and controlling sprites on a PictureBox. + /// + /// A sprite is an animated image that can be moved around on a + /// picturebox. You can give the sprite an initial location, and either move it around manually or give it + /// specific movement controls. + /// + /// To use this library, you will need to add a reference to it in your project. You will also need a reference to + /// "Windows Base." + /// In the solution explorer, if you right-click your project and go to "add", and then "reference" and click + /// "WindowsBase" towards the bottom. + /// On that same window, on the left, click "browse." Then, click the "Browse..." button and find the sprite-library dll. + /// The main places to find the SpriteLibrary and sample programs using this SpriteLibrary are here: + /// <see href="http://www.codeproject.com/Articles/1085446/Using-Sprites-Inside-Windows-Forms"/> + /// and + /// <see href="http://tyounglightsys.ddns.info/SpriteLibrary"/> + /// </summary> + internal class NamespaceDoc + { + + } + + /// <summary> + /// The various types of collisions a sprite can have. Currently only rectangle works. The other types were added when I + /// thought the different types of collision types were needed. Someday we may add these if we find they are useful, or if + /// someone else decides they want to help program the SpriteLibrary. These values are primarily used in Sprite Events + /// </summary> + public enum SpriteCollisionMethod { + /// <summary> + /// Checks if the two rectangles that contain the sprites overlap. Each rectangle is the starting location of the sprite + /// (top left) with the sprite width, and height marking the other sides of the rectangle. + /// </summary> + rectangle, + /// <summary> + /// Draws a circle (ellipse) inside the sprite rectangles and see if those ellipses overlap + /// </summary> + circle, + /// <summary> + /// Check to see if nontransparent portions of a sprite collide. Not working. + /// </summary> + transparency } + + /// <summary> + /// A structure that contains the width and height adjustment ratio. Use this if you need to manually calculate positions + /// between the PictureBox that the sprite is in, and the Background Image itself. + /// </summary> + public struct SpriteAdjustmentRatio { + /// <summary> + /// Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. + /// </summary> + public double width_ratio; + /// <summary> + /// Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. + /// </summary> + public double height_ratio; } + /// <summary> + /// The type of pause signals you can give a sprite or the sprite controller + /// </summary> + public enum SpritePauseType { + /// <summary> + /// Pause the animating. Animation resumes from the current frame when we unpause. A paused animation will continue + /// to display the same image frame until it is unpaused. + /// </summary> + PauseAnimation, + /// <summary> + /// Pause any automatic movement. Movement resumes where it was left off if you unpause. The sprite will + /// just sit there until unpaused. + /// </summary> + PauseMovement, + /// <summary> + /// Pause events. Sprite collisions, movement checks, etc are stopped until the unpause. + /// </summary> + PauseEvents, + /// <summary> + /// All pausable things are paused. PauseAnimation, PauseMovement, and PauseEvents. + /// </summary> + PauseAll } + + /// <summary> + /// A sprite controller is the main heart of the sprite class. Each SpriteController manages one picturebox. + /// If at all possible, try to keep each game in one picturebox, and try to avoid making and destroying + /// new forms with SpriteController/pictureboxes in them. It is hard to destroy them completely. + /// </summary> + /// <example> + /// A sprite controller controls animations and + /// can help you check for <see cref="SpriteController.IsKeyPressed(Keys)">key-presses.</see> To make a sprite controller, + /// you need to have one defined for your main form: + /// <code language="C#"> + /// SpriteController MySpriteController; + /// </code> + /// And then, when the form is created, after the InitializeComponents() function, you + /// need to configure the drawing area and create the sprite controller: + /// <code language="C#"> + /// MainDrawingArea.BackgroundImage = Properties.Resources.Background; + /// MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + /// MySpriteController = new SpriteController(MainDrawingArea); + /// </code> + /// In this case, MainDrawingArea is the picturebox where all the sprites will be displayed. + /// </example> + public class SpriteController + { + Image MyOriginalImage; //The untainted background + PictureBox DrawingArea; //The PictureBox we draw ourselves on + List<Sprite> Sprites = new List<Sprite>(); + + /// <summary> + /// Since everything needs a random number generator, we make one that should be accessible throughout your program. + /// </summary> + public Random RandomNumberGenerator = new Random(); + + /// <summary> + /// This is only used by the SpriteController. It allows us to queue up invalidation requests. + /// </summary> + private List<Rectangle> InvalidateList = new List<Rectangle>(); + + private KeyMessageFilter MessageFilter = new KeyMessageFilter(); + /// <summary> + /// The count of all the sprites the controller knows about. This includes named + /// sprites, which may not be visible. + /// </summary> + public int SpriteCount { get { return Sprites.Count; } } + System.Windows.Forms.Timer MyTimer = new System.Windows.Forms.Timer(); + //private bool lockObject=false; + //System.Threading.Timer ThreadTimer; + + + //These two are used for tracking mouse-leave, and mouse enter functions. + private Point MousePoint = Point.Empty; + private List<Sprite> SpritesUnderMouse = new List<Sprite>(); + private List<Sprite> SpritesUnderMouseTransparent = new List<Sprite>(); + + private SpriteAdjustmentRatio _AdjustmentRatio; + + /// <summary> + /// If your sprite images need substantial growing or shrinking when displayed, you can try setting this to "true" + /// to see if it makes it run any faster. What it does is to resize the image once, and keep a cached copy of that + /// image at that size. If you use the same sprite, but with different sizes, setting this to "True" may actually slow + /// down the game instead of speeding it up. + /// </summary> + public bool OptimizeForLargeSpriteImages = false; + + /// <summary> + /// Create a sprite controller, specifying the picturebox on which the sprites + /// will be displayed. You want to have the PictureBox already defined, and a background image + /// already set for the PictureBox. + /// </summary> + /// <example> + /// This is an example of a Form class that defines a SpriteController. The MainDrawingArea is a + /// <see cref="System.Windows.Forms.PictureBox">PictureBox.</see> + /// <code lang="C#"> + /// public partial class ShootingFieldForm : Form + /// { + /// public ShootingFieldForm() + /// { + /// InitializeComponent(); + /// MainDrawingArea.BackgroundImage = Properties.Resources.Background; + /// MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + /// MySpriteController = new SpriteController(MainDrawingArea); + /// } + /// } + /// </code> + /// </example> + /// <param name="Area">The <see cref="System.Windows.Forms.PictureBox">PictureBox.</see> + /// that the sprites will be drawn in</param> + public SpriteController(PictureBox Area) + { + DrawingArea = Area; + Local_Setup(); + } + + /// <summary> + /// Create a sprite controller, specifying the picturebox on which the sprites + /// will be displayed. + /// </summary> + /// <example> + /// This is an example of a Form class that defines a SpriteController. The MainDrawingArea is a + /// <see cref="System.Windows.Forms.PictureBox">PictureBox.</see> While defining the SpriteController, we + /// are also setting a function used for the <see cref="SpriteLibrary.SpriteController.DoTick">DoTick.</see> event. + /// <code lang="C#"> + /// public partial class ShootingFieldForm : Form + /// { + /// public ShootingFieldForm() + /// { + /// InitializeComponent(); + /// MainDrawingArea.BackgroundImage = Properties.Resources.Background; + /// MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + /// MySpriteController = new SpriteController(MainDrawingArea, CheckForKeyPress); + /// } + /// + /// private void CheckForKeyPress(object sender, EventArgs e) + /// { + /// //Do stuff here + /// } + /// } + /// + /// </code> + /// </example> + /// <param name="Area">The picturebox that the sprites will be drawn in</param> + /// <param name="TimerTickMethod">A function on the form that you want to have run every tick</param> + public SpriteController(PictureBox Area, System.EventHandler TimerTickMethod) + { + DrawingArea = Area; + Local_Setup(); + DoTick += new System.EventHandler(TimerTickMethod); + } + + + /// <summary> + /// Define some things and set up some things that need defining at instantiation + /// </summary> + private void Local_Setup() + { + //Make a clone of the background image. We take images from the "original image" + //when we want to erase a sprite and re-draw it elsewhere. + if (DrawingArea.BackgroundImage == null) + { + DrawingArea.BackgroundImage = new Bitmap(800, 600); + Graphics.FromImage(DrawingArea.BackgroundImage).FillRectangle(new SolidBrush(Form.DefaultBackColor), + new Rectangle(0,0,800,600)); //Fill it with the default background color. + } + MyOriginalImage = (Image)DrawingArea.BackgroundImage.Clone(); //Duplicate it and store it + //The messagefilter allows us to check for keypresses. + Application.AddMessageFilter(MessageFilter); + + //Set up the timer. + MyTimer.Interval = 10; + MyTimer.Tick += TimerTick; + MyTimer.Start(); + //ThreadTimer = new System.Threading.Timer(TryTimer, null, 0, 10); + + //Add a mouseclick event + DrawingArea.MouseClick += MouseClickOnBox; + DrawingArea.MouseHover += MouseHover; + DrawingArea.MouseMove += MouseMove; + + //Add a function to be called when the parent form is resized. This keeps things from + //Misbehaving immediately after a resize. + Form tParent = (Form)DrawingArea.FindForm(); + //tParent.ResizeEnd += ProcessImageResize; + tParent.SizeChanged += ProcessImageResize; + } + + /// <summary> + /// Change the Tick Interval. By default, the spritecontroller does a tick every 10ms, which + /// is very fast. Some people may prefer it to happen less regularly. Must be > 5, and less than 1001 + /// </summary> + /// <param name="newTickMilliseconds">The new tick interval</param> + public void ChangeTickInterval(int newTickMilliseconds) + { + if (newTickMilliseconds < 5) return; + if (newTickMilliseconds > 1000) return; + MyTimer.Interval = newTickMilliseconds; + } + + //private void TryTimer(object state) + //{ + // if (System.Threading.Monitor.TryEnter(lockObject,10)) + // { + // try + // { + // // Work here + // DoTick(null,null); + // } + // finally + // { + // System.Threading.Monitor.Exit(lockObject); + // } + // } + //} + + /// <summary> + /// Allow the sprite sort-method to be overridden. + /// </summary> + /// <example> + /// The default sprite sort method is: + /// <code lang="C#"> + /// SpriteComparisonDelegate = delegate (Sprite first, Sprite second) { return first.Zvalue.CompareTo(second.Zvalue); }; + /// </code> + /// Which compares just the Zvalues of the two sprites. Often you will want to have a more refined sort. The sort + /// order determines which sprites appear on top of other sprites. In the default state, if two sprites have the + /// same Zvalue, it is very uncleaer which one will draw on top of the other one. By overridding this sort function, + /// you can specify a very precise order of which sprite is on top and which is behind. + /// </example> + public Comparison<Sprite> SpriteComparisonDelegate = null; + + /// <summary> + /// This is what happens when someone clicks on the PictureBox. We want to pass any Click events to the Sprite + /// </summary> + /// <param name="sender"></param> + /// <param name="e"></param> + private void MouseClickOnBox(object sender, MouseEventArgs e) + { + List<Sprite> SpritesHere = SpritesAtPoint(e.Location); + foreach(Sprite one in SpritesHere.ToList()) + { + one.ClickedOn(SpriteCollisionMethod.rectangle); + if (one.SpriteAtPictureBoxPoint(e.Location, SpriteCollisionMethod.transparency)) + one.ClickedOn(SpriteCollisionMethod.transparency); + } + } + + /// <summary> + /// Check to see if we are hovering over anything + /// </summary> + /// <param name="sender"></param> + /// <param name="e"></param> + private void MouseHover(object sender, EventArgs e) + { + if (MousePoint == Point.Empty) return; + List<Sprite> SpritesHere = SpritesAtPoint(MousePoint); + Point Place = DrawingArea.PointToClient(Cursor.Position); + foreach (Sprite one in SpritesHere.ToList()) + { + + one.HoverOver(); + if (one.SpriteAtPictureBoxPoint(Place, SpriteCollisionMethod.transparency)) + one.HoverOverTransparent(); + } + } + + //Track when we move over a new sprite, and when we leave a sprite. Check to see if the sprite + //Is transparent at that spot to determine if we are moving over transparent or just in the rectangle + private void MouseMove(object sender, MouseEventArgs e) + { + try { + MousePoint = e.Location; + List<Sprite> SpritesHere = SpritesAtPoint(e.Location); + List<Sprite> OldSprites = new List<Sprite>(); + List<Sprite> OldSpritesTransparent = new List<Sprite>(); + List<Sprite> NewSpritesTransparent = new List<Sprite>(); + OldSprites.AddRange(SpritesUnderMouse); + OldSpritesTransparent.AddRange(SpritesUnderMouseTransparent); + SpritesUnderMouse.Clear(); + SpritesUnderMouseTransparent.Clear(); + bool IsTransparent = false; + Point Place = MousePoint; + foreach (Sprite one in SpritesHere.ToList()) + { + IsTransparent = false; + //Console.WriteLine("Testing mouseover"); + if (one.SpriteAtPictureBoxPoint(Place, SpriteCollisionMethod.transparency)) + { + // Console.WriteLine("Is Transparent!"); + IsTransparent = true; + NewSpritesTransparent.Add(one); + } + if (!OldSprites.Contains(one)) + { + //This is the first time we have run into it + one.Enter(); + } + if (IsTransparent && !OldSpritesTransparent.Contains(one)) + { + //Console.WriteLine("Calling EnterTransparent"); + one.EnterTransparent(); + } + if (IsTransparent) + { + OldSpritesTransparent.Remove(one); + } + OldSprites.Remove(one); + } + //Now, anything we have not "removed" is a sprite we are no longer over. + foreach (Sprite donewith in OldSprites.ToList()) + { + donewith.Leave(); + } + foreach (Sprite donewith in OldSpritesTransparent.ToList()) + { + //Console.WriteLine("Calling LeaveTransparent"); + donewith.LeaveTransparent(); + } + SpritesUnderMouse.AddRange(SpritesHere); + SpritesUnderMouseTransparent.AddRange(NewSpritesTransparent); + } + catch (AggregateException ee) + { + Console.WriteLine(ee.ToString()); + } + } + + /// <summary> + /// Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + /// or want to have a different background + /// <example> + /// Replacing the background image is actually a lot more complex than you might imagine. Once you use the + /// below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + /// a number of small ways. + /// You need to tell the sprite controller that you are replacing the background image, + /// and you need to change the image to that image as well.Because the Images are actually + /// pointers to memory where the image sets, changes to one image will affect the other image.This goofs + /// things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + /// copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + /// to invalidate itself.That does everything that is needed. + /// <code lang="C#"> + /// void ReplaceBackground(Image NewBackground) + ///{ + /// if (MyController == null) return; + /// if (NewBackground == null) return; + /// + /// Image OneImage = new Bitmap(NewBackground); + /// MyController.ReplaceOriginalImage(OneImage); + /// + /// Image TwoImage = new Bitmap(NewBackground); + /// pb_map.BackgroundImage = TwoImage; + /// pb_map.Invalidate(); + ///} + /// </code> + /// </example> + /// </summary> + /// <param name="tImage">The new image that all sprites will be drawn on</param> + public void ReplaceOriginalImage(Image tImage) + { + if(MyOriginalImage == null) + { + MyOriginalImage = (Image)DrawingArea.BackgroundImage.Clone(); + } + else + { + Graphics.FromImage(MyOriginalImage).Clear(Color.Transparent); //erase the old image + Graphics.FromImage(MyOriginalImage).DrawImage(tImage, new Rectangle(0, 0, MyOriginalImage.Width, MyOriginalImage.Height)); + Graphics.FromImage(DrawingArea.BackgroundImage).Clear(Color.Transparent); //erase the old image + Graphics.FromImage(DrawingArea.BackgroundImage).DrawImage(tImage, new Rectangle(0, 0, MyOriginalImage.Width, MyOriginalImage.Height)); + } + DrawingArea.Invalidate(); + } + + /// <summary> + /// Notify the sprite controller that you have changed the background image on the + /// PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. + /// </summary> + public void ReplaceOriginalImage() + { + if (MyOriginalImage == null) + { + MyOriginalImage = (Image)DrawingArea.BackgroundImage.Clone(); + } + else + { + Graphics.FromImage(MyOriginalImage).DrawImage(DrawingArea.BackgroundImage, new Rectangle(0, 0, MyOriginalImage.Width, MyOriginalImage.Height)); + } + } + + /// <summary> + /// The function called by the timer every 10 millisecods We also call do_tick, which + /// is the function defined by the user. This is usually where they will do the majority of the work. + /// </summary> + /// <param name="sender"></param> + /// <param name="e"></param> + private void TimerTick(object sender, EventArgs e) + { + //If we have added a function to call on the timer, do it. + DoTick(sender, e); + Tick(); + } + + /// <summary> + /// The function called by the timer every 10 millisecods This is usually where you will do the majority of the work. + /// You can define this manually, or when you <see cref="SpriteLibrary.SpriteController.SpriteController(PictureBox, EventHandler)">instantiate the SpriteController</see> + /// </summary> + /// <example> + /// The Sprite controller uses a <see cref="System.Windows.Forms.Timer">System.Windows.Forms.Timer.</see> This timer is notoriously un-precise, but it is very + /// easy to set up initially. It tries to fire off every 10 milliseconds, but it can fire off incredibly + /// slowly if you have long pieces of code; the DoTick function needs to finish before it can start again. You want all your + /// functions to run as quickly as possible to avoid things looking jerky. + /// Most programs you will make using the sprite library will begin by tapping into the DoTick Event. + /// Every time the sprite controller is ready to pass control back to your program, it will call + /// the DoTick event. You want to see if you should be doing anything, and then exiting the do-tick function. + /// <code lang = "C#"> + /// public partial class ShootingFieldForm : Form + /// { + /// public ShootingFieldForm() + /// { + /// InitializeComponent(); + /// MainDrawingArea.BackgroundImage = Properties.Resources.Background; + /// MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + /// MySpriteController = new SpriteController(MainDrawingArea, CheckForKeyPress); + /// } + /// + /// private void CheckForKeyPress(object sender, EventArgs e) + /// { + /// bool left = false; + /// bool right = false; + /// bool space = false; + /// bool didsomething = false; + /// TimeSpan duration = DateTime.Now - LastMovement; + /// if (duration.TotalMilliseconds < 100) + /// return; + /// LastMovement = DateTime.Now; + /// if (MySpriteController.IsKeyPressed(Keys.A) || MySpriteController.IsKeyPressed(Keys.Left)) + /// { + /// left = true; + /// } + /// if (MySpriteController.IsKeyPressed(Keys.D)||MySpriteController.IsKeyPressed(Keys.Right)) + /// { + /// right = true; + /// } + /// if (left && right) return; //do nothing if we conflict + /// if (left) + /// { + /// if (LastDirection != MyDir.left) + /// { + /// Spaceship.SetSpriteDirectionDegrees(180); + /// //We want to only change animation once. Every time we change + /// //the animation, it starts at the first frame again. + /// Spaceship.ChangeAnimation(0); + /// LastDirection = MyDir.left; + /// } + /// didsomething = true; + /// Spaceship.MovementSpeed = 15; + /// Spaceship.AutomaticallyMoves = true; + /// } + /// if (right) + /// { + /// if (LastDirection != MyDir.right) + /// { + /// Spaceship.SetSpriteDirectionDegrees(0); + /// Spaceship.ChangeAnimation(0); + /// LastDirection = MyDir.right; + /// } + /// didsomething = true; + /// Spaceship.AutomaticallyMoves = true; + /// Spaceship.MovementSpeed = 15; + /// } + /// if(!didsomething) + /// { + /// LastDirection = MyDir.stopped; + /// //No keys pressed. Stop moving + /// Spaceship.MovementSpeed = 0; + /// } + /// } + /// </code> + /// </example> + public event EventHandler DoTick = delegate { }; + + /// <summary> + /// Process a form resize by recalculating all the picturebox locations for all sprites. + /// </summary> + /// <param name="sender">The form</param> + /// <param name="e">Form event args</param> + internal void ProcessImageResize(object sender, EventArgs e) + { + //Go through all sprites and recalculate the Ratio. + foreach (Sprite oneSprite in Sprites) + { + oneSprite.RecalcPictureBoxLocation(); + } + } + + /// <summary> + /// Count the number of sprites that were duplicated from the sprite with the specified name. When you use a + /// <see cref="SpriteLibrary.SpriteController.DuplicateSprite(string)">SpriteController.DuplicateSprite(string)</see> + /// command, it creates a new sprite that is based off the named sprite. This function will count those duplicated sprites. + /// </summary> + /// <param name="Name">The name to look for</param> + /// <returns>The count of sprites that are duplicates of the specified name</returns> + public int CountSpritesBasedOff(string Name) + { + int count = 0; + foreach (Sprite OneSprite in Sprites) + { + if (OneSprite.SpriteOriginName == Name) + count++; + } + return count; + } + + /// <summary> + /// Return a list of all sprites + /// </summary> + /// <returns>A list of all sprites</returns> + public List<Sprite> AllSprites() + { + return Sprites; + } + + /// <summary> + /// Return all sprites that were based off a particular sprite name. + /// When you use a + /// <see cref="SpriteLibrary.SpriteController.DuplicateSprite(string)">SpriteController.DuplicateSprite(string)</see> + /// command, it creates a new sprite that is based off the named sprite. This function returns a list of those + /// duplicated sprites. + /// </summary> + /// <param name="SpriteName">The sprite name to find</param> + /// <returns>A list of sprites that were based off the named sprite</returns> + public List<Sprite> SpritesBasedOff(string SpriteName) + { + List<Sprite> newList = new List<Sprite>(); + foreach(Sprite one in Sprites) + { + if (one.SpriteOriginName == SpriteName) + newList.Add(one); + } + return newList; + } + + /// <summary> + /// Return a list of all sprites which have been drawn on the image + /// </summary> + /// <returns>A list of sprites that have been drawn</returns> + public List<Sprite> SpritesThatHaveBeenDrawn() + { + List<Sprite> newList = new List<Sprite>(); + foreach (Sprite one in Sprites) + { + if (one.HasBeenDrawn) + newList.Add(one); + } + return newList; + } + + /// <summary> + /// Return a list of all sprites which are not master sprites (which are duplicates of something) + /// </summary> + /// <returns>A list of sprites</returns> + public List<Sprite> SpritesBasedOffAnything() + { + List<Sprite> newList = new List<Sprite>(); + foreach (Sprite one in Sprites) + { + if (one.SpriteOriginName != "" && one.SpriteOriginName != null) + newList.Add(one); + } + return newList; + } + + /// <summary> + /// Return an adjustment ratio. This is the image-size to picture-box ratio. + /// It is used for calculating precise pixels or picture-box locations. + /// </summary> + /// <returns>A SpriteAdjustmentRatio containing the current ratio of picture-box pixels to image-box pixels</returns> + public SpriteAdjustmentRatio ReturnAdjustmentRatio() + { + + //if (_AdjustmentRatio.height_ratio != 0 && _AdjustmentRatio.width_ratio != 0) + // return _AdjustmentRatio; + //default to stretch + lock(DrawingArea) lock (MyOriginalImage) + { + + SpriteAdjustmentRatio Ratio = new SpriteAdjustmentRatio(); + switch (DrawingArea.BackgroundImageLayout) + { + case ImageLayout.Center: + case ImageLayout.None: + case ImageLayout.Tile: + case ImageLayout.Zoom: + case ImageLayout.Stretch: + default: + //This is the code for Stretch. + double CRW = DrawingArea.ClientRectangle.Width; + double MOIW = MyOriginalImage.Width; + Ratio.width_ratio =CRW / MOIW; + double CRH = DrawingArea.ClientRectangle.Height; + double MOIH = MyOriginalImage.Height; + Ratio.height_ratio = CRH / MOIH; + break; + } + _AdjustmentRatio = Ratio; + return Ratio; + } + } + + /// <summary> + /// This takes a point, the location on a picturebox, and returns the corresponding point on the BackgroundImage. + /// Picturebox locations are "sloppy"; the background image locations are very precise. Since this takes a "sloppy" + /// number and returns a precise number, it does some rounding to figure out where the specified location is. + /// </summary> + /// <param name="LocationOnPicturebox">A point on the picturebox that you want the corresponding image pixel location for.</param> + /// <returns>A point (x,y) on the background image which corresponds to the picture-box coordinates you sent into the function.</returns> + public Point ReturnPointAdjustedForImage(Point LocationOnPicturebox) + { + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + Point returnedPoint = new Point((int)(LocationOnPicturebox.X / Ratio.width_ratio), (int)(LocationOnPicturebox.Y / Ratio.height_ratio)); + return returnedPoint; + } + + /// <summary> + /// Return the height of an object in picture-box terms. It is basically the virtual height + /// of the sprite or other item. + /// </summary> + /// <param name="Height">The image-box heigh (or sprite height)</param> + /// <returns>An integer that corresponds to the hight as displayed in the picturebox</returns> + public int ReturnPictureBoxAdjustedHeight(int Height) + { + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + int returnedAmount = (int)(Height * Ratio.height_ratio); + return returnedAmount; + } + + /// <summary> + /// Return the width of an object in picture-box terms. It takes the width of a sprite or other + /// item that is being displayed on the screen, and calculates the width as displayed in the + /// picture-box (taking into consideration stretching or shrinking) + /// </summary> + /// <param name="Width">An integer width of the drawn item</param> + /// <returns>An integer that contains the number of pixels wide it is on the picturebox</returns> + public int ReturnPictureBoxAdjustedWidth(int Width) + { + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + int returnedAmount = (int)(Width * Ratio.width_ratio); + return returnedAmount; + } + + /// <summary> + /// This does the reverse of an adjusted point. It takes a point on the image and + /// transforms it to one on the PictureBox + /// </summary> + /// <param name="LocationOnImage">A point on the image, using the x and y pixels on the image</param> + /// <returns>A location that can be used on the picture-box, taking into consideration the image being stretched.</returns> + public Point ReturnPictureBoxAdjustedPoint(Point LocationOnImage) + { + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + Point returnedPoint = new Point((int)(LocationOnImage.X * Ratio.width_ratio), (int)(LocationOnImage.Y * Ratio.height_ratio)); + return returnedPoint; + } + + /// <summary> + /// Adjust a rectangle that is based on the image, according to the stretch of the picturebox + /// </summary> + /// <param name="ImageRectangle">A rectangle using coordinates from the image</param> + /// <returns>a rectangle that is adjusted for the PictureBox</returns> + public Rectangle AdjustRectangle(Rectangle ImageRectangle) + { + if (DrawingArea.BackgroundImageLayout == ImageLayout.Stretch) + { + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + double width_ratio = Ratio.width_ratio; + double height_ratio = Ratio.height_ratio; + int x, y, width, height; + x = (int)(ImageRectangle.X * width_ratio); + y = (int)(ImageRectangle.Y * height_ratio); + width = (int)(ImageRectangle.Width * width_ratio); + height = (int)(ImageRectangle.Height * height_ratio); + + Rectangle newRec = new Rectangle(x, y, width, height); + return newRec; + } + + return ImageRectangle; //If we do not know what it is, return the curent + } + + /// <summary> + /// Adjust an image point so that it conforms to the picturebox. + /// </summary> + /// <param name="LocationOnImage">The image location</param> + /// <returns>the corresponding point on the PictuerBox</returns> + public Point AdjustPoint(Point LocationOnImage) + { + SpriteAdjustmentRatio Ratio = ReturnAdjustmentRatio(); + double width_ratio = Ratio.width_ratio; + double height_ratio = Ratio.height_ratio; + int x, y; + x = (int)(LocationOnImage.X * width_ratio); + y = (int)(LocationOnImage.Y * height_ratio); + return new Point(x, y); + } + + /// <summary> + /// Invalidate a rectangle that is specified in image coordinates + /// </summary> + /// <param name="ImageRectangle">A rectangle based on the image coordinates</param> + /// <param name="QueueUpInvalidation">Whether to do it now, or to queue it up for another time.</param> + public void Invalidate(Rectangle ImageRectangle, bool QueueUpInvalidation = true) + { + if (QueueUpInvalidation) + { + InvalidateList.Add(ImageRectangle); + } + else + { + //Figure out the area we are looking at + if (DrawingArea.BackgroundImageLayout == ImageLayout.Stretch) + { + Rectangle newRec = AdjustRectangle(ImageRectangle); + newRec = new Rectangle(newRec.Location.X, newRec.Location.Y, newRec.Width + 2, newRec.Height + 2); + //Now we invalidate the adjusted rectangle + DrawingArea.Invalidate(newRec); + } + } + } + + /// <summary> + /// Invalidate the entire image on which the sprites are drawn + /// </summary> + /// <param name="QueueUpInvalidation">Whether to do it now, or to queue it up for another time.</param> + public void Invalidate(bool QueueUpInvalidation = true) + { + Invalidate(DrawingArea.ClientRectangle); + } + + /// <summary> + /// The Background Image on which the sprites are drawn. This image ends up having + /// sprite parts on it. The OriginalImage is the version that is clean. Use + /// ReplaceOriginalImage to replace the background Image. + /// </summary> + public Image BackgroundImage { get { return DrawingArea.BackgroundImage; } } + /// <summary> + /// The Image from which the background is taken when we erase sprites. The BackgroundImage + /// is the image that contains images of the sprites as well as the background image. Use + /// ReplaceOriginalImage to replace this and the BackgroundImage. + /// </summary> + public Image OriginalImage { get { return MyOriginalImage; } } + + + //void Tick() + //{ + // BackgroundWorker bw = new BackgroundWorker(); + + // // this allows our worker to report progress during work + // bw.WorkerReportsProgress = true; + + // // what to do in the background thread + // bw.DoWork += new DoWorkEventHandler( + // delegate (object o, DoWorkEventArgs args) + // { + + // ThreadTick(); + + // }); + // bw.RunWorkerAsync(); + + //} + + void Tick() + { + try + { + //We check for collisions. + for (int looper = 0; looper < Sprites.Count; looper++) + { + if (Sprites[looper] != null && !Sprites[looper].Destroying && Sprites[looper].HasBeenDrawn) + { + for (int checkloop = 0; checkloop < Sprites.Count; checkloop++) + { + if (Sprites[checkloop] != null && !Sprites[checkloop].Destroying && Sprites[checkloop].HasBeenDrawn) + { + //Check to see if they have hit + Sprites[looper].CheckSpriteHitsSprite(Sprites[checkloop], SpriteCollisionMethod.rectangle); + } + } + } + } + + //We do a tick for each sprite + //Parallel.ForEach(Sprites.ToList(), tSprite => + //{ + // if (!tSprite.Destroying) + // { + // tSprite.Tick(); + // } + //}); + + foreach (Sprite tSprite in Sprites.ToList()) + { + if (!tSprite.Destroying) + { + tSprite.Tick(); + } + }; + + foreach (Sprite tSprite in Sprites.ToList()) + { + if (!tSprite.Destroying) + { + tSprite.ActuallyDraw(); + } + } + foreach(Rectangle rec in InvalidateList) + { + Invalidate(rec, false); + } + InvalidateList.Clear(); + } + catch (AggregateException e) + { + Console.WriteLine(e.ToString()); + } + } + + /// <summary> + /// Make a duplicate of the specified sprite. The duplicate does not yet have a location. + /// </summary> + /// <param name="What">The sprite to duplicate</param> + /// <returns>A new sprite. If What is null, returns null</returns> + public Sprite DuplicateSprite(Sprite What) + { + //Make a new sprite that is based off of the old one + if (What == null) return null; + return new Sprite(What); + } + + /// <summary> + /// Find a sprite that has been named with the specified name. Then duplicate that sprite + /// </summary> + /// <example> + /// Below is a function that creates a sprite based off a name, and puts it at the designated coordinates. + /// <code lang="C#"> + /// public void AddSprite(string name, int startx, int starty) + /// { + /// Sprite NewSprite = MySpriteController.DuplicateSprite(What.ToString()); + /// if(NewSprite != null) + /// { + /// NewSprite.AutomaticallyMoves = true; + /// NewSprite.CannotMoveOutsideBox = true; + /// NewSprite.SetSpriteDirectionDegrees(180); //left + /// NewSprite.PutBaseImageLocation(new Point(startx, starty)); + /// NewSprite.MovementSpeed = 5; + /// } + /// } + /// </code> + /// </example> + /// <param name="Name">The name of a sprite</param> + /// <returns>A duplicate of the specified sprite. It has no location, and does not retain the sprite name.</returns> + public Sprite DuplicateSprite(string Name) + { + Sprite tSprite = SpriteFromName(Name); + if (tSprite == null) return null; + return new Sprite(tSprite); //Make a new sprite that is based off the original + } + + /// <summary> + /// Find a sprite that has a specified name. This returns the actual sprite with that name. + /// You usually want to use DuplicateSprite(Name) to clone the sprite and get one you can + /// destroy. If you destroy a named sprite without duplicating it, you may end up losing + /// it for the remainder of the program. + /// </summary> + /// <param name="Name">A string that matches something added to a sprite with Sprite.SetName</param> + /// <returns>A sprite that has the specified name, or null if no such sprite exists.</returns> + public Sprite SpriteFromName(string Name) + { + foreach (Sprite OneSprite in Sprites) + { + if (OneSprite.SpriteName == Name) + { return OneSprite; } + } + return null; + } + + /// <summary> + /// Add the specified sprite to the list of sprites we know about. You usually do not need to do this. + /// Sprites add themselves to the controller when you create a new sprite. + /// </summary> + /// <param name="SpriteToAdd">The sprite to add to the sprite-controller</param> + public void AddSprite(Sprite SpriteToAdd) + { + Sprites.Add(SpriteToAdd); + SortSprites(); + } + + /// <summary> + /// Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + /// the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + /// and remove itself from the controller. After it is destroyed, it is completely gone. + /// </summary> + /// <param name="what">The Sprite to destroy</param> + public void DestroySprite(Sprite what) + { + if (what == null) return; + Sprites.Remove(what); + if (!what.Destroying) + { + what.Destroy(); + } + } + + /// <summary> + /// Remove all sprites (even named sprites that have not yet been displayed) + /// </summary> + public void DestroyAllSprites() + { + for(int i= Sprites.Count -1; i>=0; i--) + { + Sprites[i].Destroy(); + } + } + + /// <summary> + /// Find the specified Sprite in the controller and change its name to the specified string. + /// You can do the same thing with <see cref="SpriteLibrary.Sprite.SetName(string)">Sprite.SetName(Name)</see> + /// </summary> + /// <param name="What">The Sprite to find</param> + /// <param name="Name">The string to change the name to</param> + public void NameSprite(Sprite What, string Name) + { + What.SetName(Name); + } + + /// <summary> + /// This takes a point, as given by the mouse-click args, and returns the sprites at that point. Different + /// functions use different coordinates, whether based off the background image, or based off the picturebox. + /// This one uses the picturebox coordinates. So you can use this directly from a MouseDown or MouseUp function. + /// </summary> + /// <param name="Location">The picture-box point being clicked on</param> + /// <returns>A list of sprites that are all at the specified point.</returns> + public List<Sprite> SpritesAtPoint(Point Location) + { + List<Sprite> tList = new List<Sprite>(); + foreach (Sprite OneSprite in Sprites) + { + if (OneSprite.HasBeenDrawn && OneSprite.SpriteAtPictureBoxPoint(Location)) + { + tList.Add(OneSprite); + } + } + return tList; + } + /// <summary> + /// This takes a point, as as specified on the image, and returns the sprites at that point. Different + /// functions use different coordinates, whether based off the background image, or based off the picturebox. + /// This one uses the background image coordinates. Use SpritesAdPoint() if you are doing something based off + /// a MouseUp or MouseDown function. This is used for functions based on sprite location or based off the absoloute + /// location (using the background image location is much more precise than the visible location in the picturebox) + /// </summary> + /// <param name="Location">The point being looked at</param> + /// <returns>A list of sprites that are all at the specified image point</returns> + public List<Sprite> SpritesAtImagePoint(Point Location) + { + List<Sprite> tList = new List<Sprite>(); + foreach (Sprite OneSprite in Sprites) + { + if (OneSprite.HasBeenDrawn && OneSprite.SpriteAtImagePoint(Location)) + { + tList.Add(OneSprite); + } + } + return tList; + } + + /// <summary> + /// Return a list of all the sprites that intersect with the given background-image-based rectangle + /// </summary> + /// <param name="Location">The rectangle on the image we are trying to find</param> + /// <returns>A list of the sprites that have any portion of it inside the rectangle</returns> + public List<Sprite> SpritesInImageRectangle(Rectangle Location) + { + List<Sprite> tList = new List<Sprite>(); + foreach (Sprite OneSprite in Sprites) + { + if (OneSprite.HasBeenDrawn && OneSprite.SpriteIntersectsRectangle(Location)) + { + tList.Add(OneSprite); + } + } + return tList; + } + /// <summary> + /// Check to see if any keys are pressed. There is a small glitch with the + /// key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + /// triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + /// lost focus. + /// </summary> + /// <returns>True if a key is pressed, false if no keys are pressed.</returns> + public bool IsKeyPressed() + { + return MessageFilter.IsKeyPressed(); + } + + /// <summary> + /// Return a list of all the keys that are currently pressed. There is a small glitch with the + /// key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + /// triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + /// lost focus. + /// </summary> + /// <returns>A List of Keys which are currently considered to be pressed.</returns> + public List<Keys> KeysPressed() + { + return MessageFilter.KeysPressed(); + } + + /// <summary> + /// Check to see if the given key is pressed. There is a small glitch with the + /// key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + /// triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + /// lost focus. + /// </summary> + /// <param name="k">The key to check to see if it is pressed</param> + /// <returns>True if the key is pressed, false if that key is not pressed</returns> + public bool IsKeyPressed(Keys k) + { + return MessageFilter.IsKeyPressed(k); + } + + /// <summary> + /// If you want to have a KeyDown function that is triggered by a keypress function, add the event here. + /// The event should have the parameters (object sender, KeyEventArgs e) + /// </summary> + /// <param name="Func">The function to set</param> + public void RegisterKeyDownFunction(SpriteKeyEventHandler Func) + { + MessageFilter.KeyDown += Func; + } + + /// <summary> + /// If you want to have a KeyUp function that is triggered by a keypress function, add the event here. + /// The event should have the parameters (object sender, KeyEventArgs e) + /// </summary> + /// <param name="Func">The function to set</param> + public void RegisterKeyUpFunction(SpriteKeyEventHandler Func) + { + MessageFilter.KeyUp += Func; + } + + /// <summary> + /// Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + /// because a window has taken priority, or something has changed). Calling this function will reset + /// the stored memory of whether a key has been pressed. + /// </summary> + public void ResetKeypressState() + { + MessageFilter.ResetState(); + } + + /// <summary> + /// Change the display order of the specified sprite so it goes in front of all other sprites. + /// </summary> + /// <param name="What">The sprite we want to show up in front</param> + public void SpriteToFront(Sprite What) + { + What.Zvalue = 100; + } + + /// <summary> + /// Change the display order of the specified sprite so it goes behind all other sprites. + /// </summary> + /// <param name="What">The sprite to send behind all other sprites</param> + public void SpriteToBack(Sprite What) + { + What.Zvalue = 0; + } + /// <summary> + /// Change the display order of the specified sprite so it is more likely to go behind all other sprites. + /// </summary> + /// <param name="What">The sprite to send behind all other sprites</param> + public void SpriteBackwards(Sprite What) + { + What.Zvalue--; + } + /// <summary> + /// Change the display order of the specified sprite so it is more likely to go in front of other sprites + /// </summary> + /// <param name="What">The sprite to send behind all other sprites</param> + public void SpriteForwards(Sprite What) + { + What.Zvalue++; + } + /// <summary> + /// Change the display order of the sprites such that the specified sprite appears behind the other sprite. + /// </summary> + /// <param name="WhatToSend">The sprite we are changing the display order of</param> + /// <param name="ToGoBehind">The sprite we want to go behind</param> + public void PlaceSpriteBehind(Sprite WhatToSend, Sprite ToGoBehind) + { + if (WhatToSend == ToGoBehind) return; + if (WhatToSend == null) return; + if (ToGoBehind == null) return; + WhatToSend.Zvalue = ToGoBehind.Zvalue - 1; + } + + /// <summary> + /// Make the sprite go in front of the specified sprite. + /// </summary> + /// <param name="WhatToSend">The sprite to change the display order of</param> + /// <param name="ToGoInFrontOf">The sprite we want to make sure we display in front of</param> + public void PlaceSpriteInFrontOf(Sprite WhatToSend, Sprite ToGoInFrontOf) + { + if (WhatToSend == ToGoInFrontOf) return; + if (WhatToSend == null) return; + if (ToGoInFrontOf == null) return; + WhatToSend.Zvalue = ToGoInFrontOf.Zvalue + 1; + } + + //****************************// + //******* SOUND Stuff *******// + private struct SoundEntry + { + public string SoundName; + public bool HasBeenPlayed; + } + + List<SoundEntry> MySounds = new List<SoundEntry>(); + /// <summary> + /// Play a sound that we can check to see if it has completed. + /// </summary> + /// <param name="ToPlay">The sound to play</param> + /// <param name="Name">The name, which we can use to determine if it has finished.</param> + public void SoundPlay(System.IO.Stream ToPlay, string Name) + { + if (SoundIsFinished(Name)) + { + PlayAsync(ToPlay, Name, SoundIsDone); + RegisterSound(Name); + } + } + + /// <summary> + /// Play a sound bit in a separate thread. When the thread is done, set a bool saying that + /// </summary> + /// <param name="ToPlay">The sound to play</param> + /// <param name="RegisterName">The string that we can use to track the status of the sound</param> + /// <param name="WhenDone">A function that gets called when the sound is complete</param> + private void PlayAsync(System.IO.Stream ToPlay, string RegisterName, EventHandler WhenDone) + { + ToPlay.Position = 0; + System.Threading.ThreadPool.QueueUserWorkItem(delegate + { + using (System.Media.SoundPlayer player = new System.Media.SoundPlayer(ToPlay)) + { + player.PlaySync(); + } + + if (WhenDone != null) WhenDone(RegisterName, EventArgs.Empty); + }); + //new System.Threading.Thread(() => { + // var c = new System.Windows.Media.MediaPlayer(); + // byte[] buffer = new byte[ToPlay.Length]; + // int totalBytesCopied; + // for (totalBytesCopied = 0; totalBytesCopied < ToPlay.Length;) + // totalBytesCopied += ToPlay.Read(buffer, totalBytesCopied, Convert.ToInt32(ToPlay.Length) - totalBytesCopied); + // Uri tURI = Create_Memory_Resource_Uri(buffer, totalBytesCopied); + // c.Open(tURI); + // c.Play(); + // if (WhenDone != null) WhenDone(RegisterName, EventArgs.Empty); + //}).Start(); + } + + //Uri Create_Memory_Resource_Uri(byte[] in_memory_resource, int Size) + //{ + // MemoryStream packStream = new MemoryStream(); + // using ( + // Package pack = + // Package.Open(packStream, FileMode.Create, FileAccess.ReadWrite)) + // { + // Uri packUri = new Uri("AnyBeforeColon:"); + // PackageStore.AddPackage(packUri, pack); + // Uri packPartUri = new Uri("/AnyAfterSlash", UriKind.Relative); + // //PackagePart packPart = + // // pack.CreatePart(packPartUri, "application/vnd.ms-opentype"); + // PackagePart packPart = + // pack.CreatePart(packPartUri, "AnyBeforeSlash/AnyAfterSlash"); + // //MemoryStream resourceStream = new MemoryStream(in_memory_resource); + // //CopyStream(resourceStream, packPart.GetStream()); + // packPart.GetStream().Write(in_memory_resource, 0, Size); + // Uri memory_resource_uri = + // PackUriHelper.Create(packUri, packPart.Uri); + // return memory_resource_uri; + // } + //} + + private void SoundIsDone(object sender, EventArgs e) + { + string Name = (string)sender; + RemoveEntry(Name); + SoundEntry newsound = new SoundEntry(); + newsound.SoundName = Name; + newsound.HasBeenPlayed = true; //Mark it as done + MySounds.Add(newsound); + } + + private void RemoveEntry(string Name) + { + if (Name == null || Name == "") return; + for (int count = MySounds.Count - 1; count >= 0; count--) + { + if (MySounds[count].SoundName == Name) + { + MySounds.RemoveAt(count); + } + } + } + private void RegisterSound(string Name) + { + if (Name == null || Name == "") return; + RemoveEntry(Name); + SoundEntry newsound = new SoundEntry(); + newsound.SoundName = Name; + newsound.HasBeenPlayed = false; + MySounds.Add(newsound); + } + + private void RegisterSoundDone(string Name) + { + if (Name == null || Name == "") return; + RemoveEntry(Name); + SoundEntry newsound = new SoundEntry(); + newsound.SoundName = Name; + newsound.HasBeenPlayed = true; + MySounds.Add(newsound); + } + + /// <summary> + /// Check to see if the specified sound has finished playing + /// </summary> + /// <param name="Name">The name of the sound</param> + /// <returns>True if the sound is not currently playing. False if it is currently playing.</returns> + public bool SoundIsFinished(string Name) + { + foreach(SoundEntry one in MySounds.ToList()) + { + if (one.SoundName == Name) + return one.HasBeenPlayed; + } + return true; //It does not exist, therefore it is not playing + } + + /// <summary> + /// Pause everything. It loops through all the sprites in the SpriteController and sends the specified + /// SpritePauseType to each one. Look at the documentation for SpritePauseType to determine which pause + /// type to use. + /// </summary> + /// <param name="What">The SpritePauseType to send all sprites</param> + public void Pause(SpritePauseType What = SpritePauseType.PauseAll) + { + for(int i=0; i< Sprites.Count; i++) + { + Sprites[i].Pause(What); + } + } + /// <summary> + /// un-Pause everything. This will send the specified SpritePauseType unpause command + /// to all sprites. + /// </summary> + /// <param name="What">The SpritePauseType to unpause for all sprites</param> + public void UnPause(SpritePauseType What = SpritePauseType.PauseAll) + { + for (int i = 0; i < Sprites.Count; i++) + { + Sprites[i].UnPause(What); + } + } + + + internal void SortSprites() + { + //Define the sort we use if we do not have another one specified + Comparison<Sprite> G = null; + //G = delegate (Sprite first, Sprite second) { + // if(first.Zvalue != second.Zvalue) return first.Zvalue.CompareTo(second.Zvalue); + // if (first.BaseImageLocation.Y != second.BaseImageLocation.Y) return first.BaseImageLocation.Y.CompareTo(second.BaseImageLocation.Y); + // return first.BaseImageLocation.X.CompareTo(second.BaseImageLocation.X); + //}; + G = delegate (Sprite first, Sprite second) { return first.Zvalue.CompareTo(second.Zvalue); }; + if (SpriteComparisonDelegate != null) + G = SpriteComparisonDelegate; + //Sprites.Sort((x, y) => x.Zvalue.CompareTo(y.Zvalue)); + Sprites.Sort(G); + } + } + +} diff --git a/SpriteLibrary/SpriteLibrary.csproj b/SpriteLibrary/SpriteLibrary.csproj new file mode 100644 index 0000000..c9b2631 --- /dev/null +++ b/SpriteLibrary/SpriteLibrary.csproj @@ -0,0 +1,85 @@ +<?xml version="1.0" encoding="utf-8"?> +<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"> + <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" /> + <PropertyGroup> + <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration> + <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform> + <ProjectGuid>{FC04405B-2BC1-42CA-8410-A30F9BAF4B6C}</ProjectGuid> + <OutputType>Library</OutputType> + <AppDesignerFolder>Properties</AppDesignerFolder> + <RootNamespace>SpriteLibrary</RootNamespace> + <AssemblyName>SpriteLibrary</AssemblyName> + <TargetFrameworkVersion>v4.5.1</TargetFrameworkVersion> + <FileAlignment>512</FileAlignment> + <TargetFrameworkProfile> + </TargetFrameworkProfile> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' "> + <DebugSymbols>true</DebugSymbols> + <DebugType>full</DebugType> + <Optimize>false</Optimize> + <OutputPath>bin\Debug\</OutputPath> + <DefineConstants>DEBUG;TRACE</DefineConstants> + <ErrorReport>prompt</ErrorReport> + <WarningLevel>4</WarningLevel> + <DocumentationFile>bin\Debug\SpriteLibrary.XML</DocumentationFile> + <PlatformTarget>AnyCPU</PlatformTarget> + <Prefer32Bit>false</Prefer32Bit> + </PropertyGroup> + <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' "> + <DebugType>pdbonly</DebugType> + <Optimize>true</Optimize> + <OutputPath>bin\Release\</OutputPath> + <DefineConstants>TRACE</DefineConstants> + <ErrorReport>prompt</ErrorReport> + <WarningLevel>4</WarningLevel> + <DocumentationFile>bin\Release\SpriteLibrary.XML</DocumentationFile> + <Prefer32Bit>false</Prefer32Bit> + </PropertyGroup> + <ItemGroup> + <Reference Include="PresentationCore" /> + <Reference Include="System" /> + <Reference Include="System.Core" /> + <Reference Include="System.Drawing" /> + <Reference Include="System.Windows" /> + <Reference Include="System.Windows.Forms" /> + <Reference Include="System.Xml.Linq" /> + <Reference Include="System.Data.DataSetExtensions" /> + <Reference Include="Microsoft.CSharp" /> + <Reference Include="System.Data" /> + <Reference Include="System.Net.Http" /> + <Reference Include="System.Xml" /> + <Reference Include="WindowsBase" /> + </ItemGroup> + <ItemGroup> + <Compile Include="KeyMessageFilter.cs" /> + <Compile Include="Properties\Resources.Designer.cs"> + <AutoGen>True</AutoGen> + <DesignTime>True</DesignTime> + <DependentUpon>Resources.resx</DependentUpon> + </Compile> + <Compile Include="SmartImage.cs" /> + <Compile Include="Properties\AssemblyInfo.cs" /> + <Compile Include="Sprite.cs" /> + <Compile Include="SpriteController.cs" /> + <Compile Include="SpritePayload.cs" /> + </ItemGroup> + <ItemGroup> + <EmbeddedResource Include="Properties\Resources.resx"> + <Generator>ResXFileCodeGenerator</Generator> + <LastGenOutput>Resources.Designer.cs</LastGenOutput> + <SubType>Designer</SubType> + </EmbeddedResource> + </ItemGroup> + <ItemGroup> + <None Include="Resources\ChangeLog.rtf" /> + </ItemGroup> + <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> +  +</Project> \ No newline at end of file diff --git a/SpriteLibrary/SpritePayload.cs b/SpriteLibrary/SpritePayload.cs new file mode 100644 index 0000000..30e6c6f --- /dev/null +++ b/SpriteLibrary/SpritePayload.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace SpriteLibrary +{ + /// <summary> + /// The SpritePayload is a stub of a class, for storing user-defined data and functions along with a sprite. + /// </summary> + /// <example> + /// Basically, you want to "override" this class. You do this by making your + /// own class that looks something like: + /// <code lang="C#"> + /// public class TankPayload : SpritePayload + /// { + /// public int Armor = 20; + /// public int FireTime = 100; + /// } + /// </code> + /// And then you add that to your sprite: + /// <code lang="C#">TankSprite.Payload = new TankPayload(); </code> + /// If there is no payload, then the payload + /// property is null. If you have multiple types of SpritePayloads, you may need to do something like: + /// <code lang="C#"> + /// if(TankSprite.payload != null and TankSprite.payload is TankPayload) + /// { + /// TankPayload tPayload = (TankPayload)TankSprite.payload; tPayload.Armor--; + /// } + /// </code> + /// </example> + public class SpritePayload + { + } +} diff --git a/SpriteLibrary/bin/Release/SpriteLibrary.XML b/SpriteLibrary/bin/Release/SpriteLibrary.XML new file mode 100644 index 0000000..5c53934 --- /dev/null +++ b/SpriteLibrary/bin/Release/SpriteLibrary.XML @@ -0,0 +1,1766 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SpriteLibrary</name> + </assembly> + <members> + <member name="T:SpriteLibrary.SpriteKeyEventHandler"> + <summary> + This is a delegate for a keypress event. + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="T:SpriteLibrary.KeyMessageFilter"> + <summary> + This is a system that can be used to check for any keypress on a form. It is usually used through <see cref="M:SpriteLibrary.SpriteController.IsKeyPressed(System.Windows.Forms.Keys)"/> + </summary> + <example> + You want to define a variable on your form, something like: + <code Lang="C#"> + private KeyMessageFilter the_filter = new KeyMessageFilter(); + </code> + When the form loads (in the <see cref="E:System.Windows.Forms.Form.Load"/> + event of the form), set the filter with: + <code Lang="C#"> + Application.AddMessageFilter(the_filter); + </code> + And then, to use it, do something like: + <code Lang="C#"> + bool Up = m_filter.IsKeyPressed(Keys.W); + bool Down = m_filter.IsKeyPressed(Keys.S); + </code> + Much of this code was found here: <see href="http://stackoverflow.com/questions/1100285/how-to-detect-the-currently-pressed-key"/> + </example> + </member> + <member name="T:SpriteLibrary.Properties.Resources"> + <summary> + A strongly-typed resource class, for looking up localized strings, etc. + </summary> + </member> + <member name="P:SpriteLibrary.Properties.Resources.ResourceManager"> + <summary> + Returns the cached ResourceManager instance used by this class. + </summary> + </member> + <member name="P:SpriteLibrary.Properties.Resources.Culture"> + <summary> + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + </summary> + </member> + <member name="P:SpriteLibrary.Properties.Resources.ChangeLog"> + <summary> + Looks up a localized string similar to {\rtf1\ansi\ansicpg1252\deff0\nouicompat\deflang1033{\fonttbl{\f0\fnil\fcharset0 Calibri;}} + {\colortbl ;\red0\green0\blue255;} + {\*\generator Riched20 10.0.10586}\viewkind4\uc1 + \pard\sa200\sl276\slmult1\f0\fs22\lang9 This is the Running Demo, which was created to test out the SpriteController: {{\field{\*\fldinst{HYPERLINK http://www.codeproject.com/Articles/1085446/Using-Sprites-Inside-Windows-Forms }}{\fldrslt{http://www.codeproject.com/Articles/1085446/Using-Sprites-Inside-Windows-Forms\ul0\cf0}}}}\f0 [rest of string was truncated]";. + </summary> + </member> + <member name="T:SpriteLibrary.AnimationSingleFrame"> + <summary> + A single frame of an animation + </summary> + </member> + <member name="T:SpriteLibrary.Animation"> + <summary> + One animation. A series of images. + </summary> + </member> + <member name="M:SpriteLibrary.Animation.#ctor(System.Drawing.Point,SpriteLibrary.SmartImage,System.Drawing.Image,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Create an image from an image that has a bunch of frames in the one image. + Start at the specified position (Start), and grab Count items (if we can find them) + </summary> + <param name="Count">The number of frames to grab</param> + <param name="Start">A point in the image where we start capturing frames</param> + <param name="Smart_Image">The smart image this is part of</param> + <param name="SpriteImage">the image we use for the sprite. Should have lots of images as a part of it.</param> + <param name="width">the width of each frame</param> + <param name="height">the height of each frame</param> + <param name="duration">The duration in miliseconds for this frame</param> + </member> + <member name="M:SpriteLibrary.Animation.#ctor(SpriteLibrary.SmartImage,System.Drawing.Image,System.Int32,System.Int32,System.Int32)"> + <summary> + Create an image from an image that has a bunch of frames in the one image. + Start at (0,0) with the specified height and width. Pull out as many images as we can + </summary> + <param name="Smart_Image">The smart image this is part of</param> + <param name="SpriteImage">the image we use for the sprite. Should have lots of images as a part of it.</param> + <param name="width">the width of each frame</param> + <param name="height">the height of each frame</param> + <param name="duration">The duration in miliseconds for this frame</param> + </member> + <member name="T:SpriteLibrary.SmartImage"> + <summary> + This is the holder and parser for images within the AnimatedSprite world + It allows you to store and access animations. A smart image might be a "troll" + that has a series of animations for up, down, left, right, and die. + </summary> + </member> + <member name="M:SpriteLibrary.SmartImage.#ctor(SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32,System.Int32)"> + <summary> + Make an animated image from an image that contains multiple frames + </summary> + <param name="Controller">The sprite controller this is attached to</param> + <param name="SpriteImage">The image we use to draw the animation from</param> + <param name="width">The width of the image to cut out of the main image</param> + <param name="height">The height of the image to cut out of the main image</param> + <param name="duration">The duration in miliseconds</param> + </member> + <member name="M:SpriteLibrary.SmartImage.NeedsNewImage(System.Int32,System.Int32,System.TimeSpan)"> + <summary> + Return true if the specified animation and frame for that animation needs + to be changed due to the time passing. + </summary> + <param name="animation">The animation index</param> + <param name="frame">the frame index</param> + <param name="duration">The time that has passed since the last frame was displayed.</param> + <returns></returns> + </member> + <member name="M:SpriteLibrary.SmartImage.AnimationDone(System.Int32,System.Int32,System.Boolean)"> + <summary> + Check to see if the animation is in the last frame. Only works if animateonce is set to true + </summary> + <param name="AnimateOnce">The animateOnce value of the sprite</param> + <param name="animation">The animation we think we are on</param> + <param name="frame">The frame we think we are on</param> + <returns></returns> + </member> + <member name="M:SpriteLibrary.SmartImage.AnimationFrameCount(System.Int32)"> + <summary> + Return the number of frames that the specified animation has. + </summary> + <param name="Animation">What animation to check</param> + <returns>The number of animation frames found in that animation</returns> + </member> + <member name="T:SpriteLibrary.SpriteEventArgs"> + <summary> + An EventArgs that contains information about Sprites. Most of the Sprite events use + this SpriteEventArgs. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteEventArgs.TargetSprite"> + <summary> + If another Sprite is involved in the event (Collision), than that Sprite is included here. + It will be null if no other Sprite is involved. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteEventArgs.CollisionMethod"> + <summary> + The CollisionMethod used in the event. Currently, only rectangle collisions are used + </summary> + </member> + <member name="F:SpriteLibrary.SpriteEventArgs.NewLocation"> + <summary> + For the CheckBeforeMove event, newlocation will be the location the sprite is trying + to move to. You can adjust the point (move it left, right, up, down) and it will affect + the placement of the sprite. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteEventArgs.Cancel"> + <summary> + Used primarily in the CheckBeforeMove event. If you set cancel to true, then the move fails. + You can use this to keep a Sprite from going places where it ought not to go. + </summary> + </member> + <member name="T:SpriteLibrary.Sprite"> + <summary> + A Sprite is an animated image that has a size, position, rotation, and possible vector + It tracks where in the animation sequence it is, can report colisions, etc. This SpriteController + draws, moves, and deals with most graphical aspects of the sprites for you. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.ID"> + <summary> + The Sprite ID as specified by the sprite controller. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.SpriteName"> + <summary> + The name of the sprite. Use SetSpriteName(Name) to change this name. Most Named sprites + are used to define what a sprite is. Once you have created a named sprite, you usually use + <see cref="M:SpriteLibrary.SpriteController.DuplicateSprite(System.String)"/> to clone the sprite for use. The basic rule of thumb is + to load your sprites from images once, and name the initial sprites. Then, when you go to use + those sprites, get duplicates of them. The reason for this is because it takes more processing time to initially + create the sprites than it takes to duplicate them. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.Opacity"> + <summary> + Set the opacity of the sprite. The value should be between 0 and 1. 1 is solid, 0 is transparent. + Sometimes you want to drag a sprite around the map, or show a sprite that "could be there." Setting + the sprite opacity is usually how you do that. One warning, however. The opacity value takes effect the + next time it is drawn. If the sprite is animating rapidly, it will take effect nearly emmediately. If + it is not animating, not moving, or just sitting there, then it may not take effect for quite some time. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.SpriteOriginName"> + <summary> + Return the name of the sprite that this was duplicated from. A duplicated sprite will have + no name, but will have a SpriteOriginName. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.FrameIndex"> + <summary> + This is the frame of the current animation sequence. You can use this if you need to figure out what frame index + to resume something at, or something like that. + </summary> + </member> + <member name="F:SpriteLibrary.Sprite._FinalFrameAfterAnimation"> + <summary> + The final frame is the one that gets displayed once the animation has finished. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.AnimationDone"> + <summary> + Report whether or not the animation has been completed. When you tell a Sprite to AnimateOnce, + this will report "false" until the animation sequence has been finished. At that time, the value + will be "True." The tricky bit is that this is a boolean. If you have not told a sprite to + animate once, it will always return "false." If a sprite is paused, this returns "false." The only + time this returns "true" is when you tell a sprite to animate once, or animate a few times, and those + times have completed. At that time, this will report "True". If you have a sprite with only one frame, + it may not look like it is "animating", but it is. It is simply animating that one frame over and over. + So, AnimationDone reports false, unless you have told it to animate_once. + </summary> + </member> + <member name="F:SpriteLibrary.Sprite.MovementSpeed"> + <summary> + The movement speed of the sprite. To make a Sprite move, you need to set the MovementSpeed, + the direction (using + <see cref="M:SpriteLibrary.Sprite.SetSpriteDirection(System.Windows.Vector)"/>, + <see cref="M:SpriteLibrary.Sprite.SetSpriteDirectionToPoint(System.Drawing.Point)"/>, + <see cref="M:SpriteLibrary.Sprite.SetSpriteDirectionRadians(System.Double)"/>, + or <see cref="M:SpriteLibrary.Sprite.SetSpriteDirectionDegrees(System.Double)"/>), and the + <see cref="P:SpriteLibrary.Sprite.AutomaticallyMoves"/> property. + The speed is calculated in pixels per amount of time. A higher number is faster than a lower number. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.MovingToPoint"> + <summary> + Tells us if we are in the process of doing a MoveTo operation. This boolean should be the + opposite of SpriteReachedEndpoint, but that boolean is poorly named. This is usually the easier + one to use. + </summary> + </member> + <member name="F:SpriteLibrary.Sprite.MovingToSprite"> + <summary> + If we are trying to collide with a sprite, we store that sprite here. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.AutomaticallyMoves"> + <summary> + Determine if the sprite automatically moves (you need to give it a direction [using one of the + SetSpriteDirection functions] and speed [MovementSpeed = X] also) + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.Zvalue"> + <summary> + A number from 0 to 100. Default = 50. Higher numbers print on top of lower numbers. If you want a sprite to + always be drawn on top of other sprites, give it a number higher than 50. If you want a sprite to go under + other sprites, make its number lower than 50. + </summary> + </member> + <member name="F:SpriteLibrary.Sprite.CannotMoveOutsideBox"> + <summary> + Determine if the sprite will automatically move outside the box. If not, it will hit the side of the box and stick + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.AnimationIndex"> + <summary> + Get or set the animation nimber. It is best to change the animation using ChangeAnimation. + It is safer. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.AnimationCount"> + <summary> + The number of animations this sprite has + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.HasBeenDrawn"> + <summary> + Report whether or not this Sprite has been drawn. If it has, then it needs to be erased at + some point in time. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.BaseImageLocation"> + <summary> + The sprite location as found on the base image. This is usually the easiest location to use. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.PictureBoxLocation"> + <summary> + The sprite location as found on the picture-box that this sprite is associated with. Used when dealing with mouse-clicks + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.GetSize"> + <summary> + Return the size of the sprite in reference to the image on which it is drawn. To get the + size of the Sprite in relation to the PictureBox, use GetVisibleSize + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.GetVisibleSize"> + <summary> + Return the relative size of the Sprite in relation to the PictureBox. If the box has been + stretched or shrunk, that affects the visible size of the sprite. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.Rotation"> + <summary> + Change the rotation of the sprite, using degrees. 0 degrees is to the right. 90 is up. + 180 left, 270 down. But, if your sprite was drawn facing up, then rotating it 90 degrees + will have it pointing left. The angle goes counter-clockwise. The image will be scaled + such that it continues to fit within the rectangle that it was originally in. This results + in a little bit of shrinking at times, but you should rarely notice that. + </summary> + </member> + <member name="F:SpriteLibrary.Sprite.MirrorHorizontally"> + <summary> + Flip the image when it gets printed. If your sprite is walking left, flipping it will + make it look like it is going right. + This works great for many things. But, if your program is gobbling memory or CPU, you may need to + consider using <see cref="M:SpriteLibrary.Sprite.AddAnimation(System.Int32,System.Boolean,System.Boolean)">Sprite.AddAnimation</see> + </summary> + </member> + <member name="F:SpriteLibrary.Sprite.MirrorVertically"> + <summary> + Flip the image when it gets printed. If your sprite looks like it is facing up, doing + this will make it look like it faces down. + This works great for many things. But, if your program is gobbling memory or CPU, you may need to + consider using <see cref="M:SpriteLibrary.Sprite.AddAnimation(System.Int32,System.Boolean,System.Boolean)">Sprite.AddAnimation</see> + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.Destroying"> + <summary> + If the Sprite is in the middle of being Destroyed, this is set to true. When a Sprite is + Destroyed, it needs to erase itself and do some house-cleaning before it actually vanishes. + During this time, you may not want to use it. It is always a good thing to verify a Sprite + is not in the middle of being destroyed before you do something important with it. To Destroy + a Sprite, use the Sprite.Destroy() function. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.SpriteReachedEndPoint"> + <summary> + This is true unless we are using MoveTo(point) or MoveTo(list of points) to tell the sprite to move + from one place to the next. This boolean tells us if it has finished or not. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.VisibleHeight"> + <summary> + The visible Height as seen in the PictureBox. It may be stretched, or shrunk from the actual + image size. + </summary> + </member> + <member name="P:SpriteLibrary.Sprite.VisibleWidth"> + <summary> + The visible width as seen in the PictureBox. The Sprite may be stretched or shrunk from the + actual image size. + </summary> + </member> + <member name="F:SpriteLibrary.Sprite.payload"> + <summary> + A Sprite can hold a payload. Use this to store extra information about the various Sprites. Health, Armor, + Shoot time, etc. But, to store information in the payload, you need to make a new class of SpritePayload. The syntax + for doing so is: + <code Lang="C#"> + public class TankPayload : SpritePayload { public int Armor; public int Speed; } + </code> + You can access the payload and retrieve the various values. + </summary> + </member> + <member name="T:SpriteLibrary.Sprite.SpriteEventHandler"> + <summary> + A delegate that has a SpriteEventArgs instead of EventArgs. Used for most + of the Sprite events. This allows us to pass more information from sprite events than + a basic EventArgs allows for + </summary> + <param name="sender">The Sprite that triggers the event</param> + <param name="e">A SpriteEventArgs class which contains Sprite Event values</param> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteInitializes"> + <summary> + This event happens right after the sprite is created. Use this to immediately set a + sprite to animate once or something like that. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteHitsPictureBox"> + <summary> + This happens when the sprite hits the border of the picture-box. + Useful for when you want to have shots explode when they hit the side. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteExitsPictureBox"> + <summary> + This happens when the sprite has exited the picture box. Useful when you want to + keep sprites from traveling on forever after exiting. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteAnimationComplete"> + <summary> + Only used when you tell an animation to animate once. At the end of the animation, + this function fires off. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteHitsSprite"> + <summary> + This happens when two sprites hit each-other. The SpriteEventArgs that is returned + contains the sprite that this sprite hits. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.CheckBeforeMove"> + <summary> + This event fires off before a sprite is drawn. Use it if you have constraints. You + can change the location or cancel the move entirely. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.Click"> + <summary> + This event happens when someone clicks on the sprite (on the rectangle in which the sprite is). + If you want the event to fire off only when someone clicks on the visible part of the sprite, + use ClickTransparent instead. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.ClickTransparent"> + <summary> + This event happens when someone clicks on the sprite (on the sprite image itself). + If the sprite is sometimes hidden, but you want the click to work even if it is not + visible at that instant, use Click instead. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.MouseHover"> + <summary> + This event happens when the mouse moves over the sprite, and then pauses. We use the hover timing from the + parent form. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.MouseEnter"> + <summary> + When the mouse moves over the sprite. Use this for a menu, when you want the menu item to glow when the + mouse is over the menu item sprite. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.MouseLeave"> + <summary> + When the mouse moves off the sprite. Use this for a menu, when you want the menu item to stop glowing when + the mouse moves away from the menu item sprite. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.MouseHoverTransparent"> + <summary> + This event happens when the mouse moves over a non-transparent portion of the sprite, and then pauses. + We use the hover timing from the parent form. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.MouseEnterTransparent"> + <summary> + When the mouse moves over a non-transparent portoin of the sprite. Use this for a menu, when you want the + menu item to glow when the mouse is over the menu item sprite. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.MouseLeaveTransparent"> + <summary> + When the mouse moves off the non-transparent portion of the sprite. Use this for a menu, when you want the + menu item to stop glowing when + the mouse moves away from the menu item sprite. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteChangesAnimationFrames"> + <summary> + When the frame of an animation changes. If you want to have something happen every time + the foot of your monster comes down, when the swing of your sword is at certain points, etc. + Check to see that the Animaton and FrameIndex are what you expect them to be. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteArrivedAtEndPoint"> + <summary> + An event for when you tell a Sprite to MoveTo(Point) a specific point, or, when you + tell the Sprite to MoveTo(list of points). When the Sprite has reached the final destination, + the Sprite fires off this event. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteArrivedAtWaypoint"> + <summary> + When you tell a sprite to MoveTo(list of points), this fires off every time it gets to + one of the points. When it gets to the final point, only the SpriteAtEndPoint event fires off. + </summary> + </member> + <member name="E:SpriteLibrary.Sprite.SpriteBeingDestroyed"> + <summary> + The Sprite has just been told to be destroyed. You might want to do some cleanup. + If you need to destroy some payload data, or tell something to cleanup after the sprite + this is where to do that. + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.#ctor(SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32)"> + <summary> + Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width + and height in the image, an animation is created. + </summary> + <param name="Controller">The sprite controller that manages this sprite</param> + <param name="SpriteImage">The image we pull the animation from</param> + <param name="width">The width of one animation frame</param> + <param name="height">The height of one animation frame</param> + </member> + <member name="M:SpriteLibrary.Sprite.#ctor(SpriteLibrary.SpriteController,System.Drawing.Image,System.Drawing.Size)"> + <summary> + Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width + and height in the image, an animation is created. + </summary> + <param name="Controller">The sprite controller that manages this sprite</param> + <param name="SpriteImage">The image we pull the animation from</param> + <param name="SpriteSize">The size of the animation frame</param> + </member> + <member name="M:SpriteLibrary.Sprite.#ctor(SpriteLibrary.SpriteController,System.Drawing.Image)"> + <summary> + Generate a new single-frame sprite from the specified image. + </summary> + <param name="Controller">The sprite controller that manages this sprite</param> + <param name="SpriteImage">The image we pull the animation from</param> + </member> + <member name="M:SpriteLibrary.Sprite.#ctor(SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32,System.Int32)"> + <summary> + Generate a new sprite. It takes a width, height, and the duration in Milliseconds for each frame + </summary> + <param name="Controller">The sprite controller</param> + <param name="SpriteImage">The image we pull the animations from</param> + <param name="width">The width of one animation frame</param> + <param name="height">the height of one animation frame</param> + <param name="durationInMilliseconds">The number of milliseconds each frame is shown for as it animates.</param> + </member> + <member name="M:SpriteLibrary.Sprite.#ctor(System.Drawing.Point,SpriteLibrary.SpriteController,System.Drawing.Image,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Create a Sprite from an animation image, specifying the number of consecutive + frames to grab. + </summary> + <param name="Start">A point on the specified image where we begin grabbing frames</param> + <param name="Controller">The Sprite controller we are associating the sprite with</param> + <param name="SpriteImage">An image that we grab the frames from</param> + <param name="width">The width of one frame</param> + <param name="height">The height of one frame</param> + <param name="duration">The number of milliseconds each frame is displayed for</param> + <param name="Count">The number of frames to grab as a part of this animation</param> + </member> + <member name="M:SpriteLibrary.Sprite.#ctor(SpriteLibrary.Sprite,System.Boolean)"> + <summary> + Create a Sprite that is based off of the specified sprite. Clone the Sprite except that + we set SpriteName = "" and OrigSpriteName = the OldSprite.SpriteName. That way we know that + the sprite was duplicated from the original, and we can still distinguish the original from + the duplicate. + </summary> + <param name="OldSprite">The Sprite to make a copy of</param> + <param name="RetainName">If we want to set this sprite name to be that of the original. This is a terrible idea. Never do it.</param> + </member> + <member name="M:SpriteLibrary.Sprite.SetName(System.String)"> + <summary> + Give this sprite a name. This way we can make a duplicate of it by specifying the name + </summary> + <param name="Name">A string that represents the new name of the sprite</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Drawing.Image,System.Int32,System.Int32)"> + <summary> + Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. + </summary> + <param name="SpriteImage">The animation image to grab the frames from</param> + <param name="width">The width of each frame</param> + <param name="height">The height of each frame</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Drawing.Image,System.Drawing.Size)"> + <summary> + Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. + </summary> + <param name="SpriteImage">The animation image to grab the frames from</param> + <param name="SpriteSize">The size of each frame</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Drawing.Image)"> + <summary> + Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. + </summary> + <param name="SpriteImage">The animation image to grab the frames from</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Drawing.Image,System.Int32)"> + <summary> + Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. + </summary> + <param name="SpriteImage">The animation image to grab the frames from</param> + <param name="duration">The duration the single frame uses before refreshing. 1000 is a good number.</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Drawing.Image,System.Int32,System.Int32,System.Int32)"> + <summary> + Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. + </summary> + <param name="SpriteImage">The animation image to grab the frames from</param> + <param name="width">The width of each frame</param> + <param name="height">The height of each frame</param> + <param name="duration">The time in milliseconds we use for each frame</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Drawing.Point,System.Drawing.Image,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Add another animation to an existing Sprite. After you add animations, you can use + ChangeAnimation to select which animation you want the specified sprite to show. + For example, you may want to have Animation 0 be a guy walking left, and animation 1 is + that same guy walking right. Because we do not specify the number of frames, it starts + at the top-left corner and grabs as many frames as it can from the image. + </summary> + <param name="SpriteImage">The animation image to grab the frames from</param> + <param name="width">The width of each frame</param> + <param name="height">The height of each frame</param> + <param name="duration">The time in milliseconds we use for each frame</param> + <param name="Count">The number of frames we grab from the image</param> + <param name="Start">The starting position on the Image where we grab the first frame</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Int32,System.Int32)"> + <summary> + Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand. + </summary> + <param name="AnimationToCopy">An integer value specifying the animation to duplicate</param> + <param name="RotationDegrees">The amount of counter-clockwise rotation to add</param> + </member> + <member name="M:SpriteLibrary.Sprite.AddAnimation(System.Int32,System.Boolean,System.Boolean)"> + <summary> + Duplicate an animation, except rotated by the specified number of degrees. For example, if you have + a single animation (0), and you want to rotate it by 90 degrees, it will create animation 1 with that + rotation to it. In the long haul, generating a few rotated animations is less memory intensive than + rotating it on demand using the <see cref="F:SpriteLibrary.Sprite.MirrorHorizontally"/> or <see cref="F:SpriteLibrary.Sprite.MirrorVertically"/> booleans. + </summary> + <param name="AnimationToCopy">An integer value specifying the animation to duplicate</param> + <param name="MirrorHorizontal">A boolean, stating if we should mirror horizontally</param> + <param name="MirrorVertical">A boolean, stating if we should mirror vertically</param> + </member> + <member name="M:SpriteLibrary.Sprite.AnimateOnce(System.Int32,System.Int32)"> + <summary> + Start a new animation, but do it just once. You can use AnimateJustAFewTimes(1) to the same effect. + Or, you can use AnimateJustAFewTimes with a different number. The SpriteAnimationComplete event will + fire off when the animation completes. The variable, Sprite.AnimationDone will be true once the + animation finishes animating. + </summary> + <param name="AnimationFrameToEndOn">Once the animation has finished, display this animation frame. + -1, or any number that is not an actual frame, will show the last frame of the animation.</param> + <param name="WhichAnimation">The animation index you want to use</param> + </member> + <member name="M:SpriteLibrary.Sprite.AnimateJustAFewTimes(System.Int32,System.Int32,System.Int32)"> + <summary> + Start a new animation. It will complete the animation the number of times you specify. + For example, if your sprite is walking, and one animation is one step, specifying 4 here + will result in your sprite taking 4 steps and then the animation stops. You will want + to make sure you are checking for when the animation stops, using the SpriteAnimationComplete event, + checking the Sprite.AnimationDone flag. + </summary> + <param name="WhichAnimation">The animation index you want to use</param> + <param name="HowManyAnimations">The number of animations to do before it stops</param> + <param name="AnimationFrameToEndOn">Once the animation has finished, display this animation frame. + -1, or any number that is not an actual frame, will show the last frame of the animation.</param> + </member> + <member name="M:SpriteLibrary.Sprite.ChangeAnimation(System.Int32,System.Int32)"> + <summary> + Start a new animation index from scratch + </summary> + <param name="WhichAnimation">The animation index you want to use</param> + <param name="StartFrame">The first frame you want to start the animation at.</param> + </member> + <member name="M:SpriteLibrary.Sprite.ChangeAnimationSpeed(System.Int32,System.Int32)"> + <summary> + Change the animation speed of a particular animation. This looks at the first frame + and compares that frame to the speed specified. It adjusts all the animations by the + same percentage. + </summary> + <param name="WhichAnimation">The integer representing the animation to change</param> + <param name="newSpeed">The speed in milliseconds for the new animation</param> + </member> + <member name="M:SpriteLibrary.Sprite.ChangeFrameAnimationSpeed(System.Int32,System.Int32,System.Int32)"> + <summary> + Change the animation speed of a specific frame. Beware. This affects every sprite using this frame + </summary> + <param name="WhichAnimation">The index of the animation</param> + <param name="WhichFrame">The index of the frame within the animation</param> + <param name="newSpeed">The new frame duration in milliseconds</param> + </member> + <member name="M:SpriteLibrary.Sprite.GetFrameAnimationSpeed(System.Int32,System.Int32)"> + <summary> + Get the animation speed of a single frame. + </summary> + <param name="WhichAnimation">The animation we are looking at</param> + <param name="WhichFrame">The index of the frame we wish to get the speed of</param> + <returns>-1 if either index is out of range. Otherwise, return the total milliseconds of the specified frame.</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetAnimationSpeed(System.Int32)"> + <summary> + Return the animation speed of this particualar animation of the sprite. + </summary> + <param name="WhichAnimation">The animation we are looking at</param> + <returns>The speed which was set. The speed is calculated in pixels per amount of time. A higher number is faster than a lower number</returns> + </member> + <member name="M:SpriteLibrary.Sprite.ActuallyDraw"> + <summary> + Actually draw the Sprite. Never use this. It is used by the SpriteController + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.PutBaseImageLocation(System.Drawing.Point)"> + <summary> + Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + Unless you are using coordinates you have gotten from a mouse-click, this is how you want + to place a Sprite somewhere. It is the easiest way to track things. But, if you are + doing something using mouse-click coordinates, you want to use PutPictureBoxLocation + </summary> + <param name="NewLocationOnImage">The new point on the Image</param> + </member> + <member name="M:SpriteLibrary.Sprite.PutBaseImageLocation(System.Double,System.Double)"> + <summary> + Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + Unless you are using coordinates you have gotten from a mouse-click, this is how you want + to place a Sprite somewhere. It is the easiest way to track things. But, if you are + doing something using mouse-click coordinates, you want to use PutPictureBoxLocation + </summary> + <param name="X">The X location on the background image</param> + <param name="Y">the Y location on the background image</param> + </member> + <member name="M:SpriteLibrary.Sprite.PutPictureBoxLocation(System.Drawing.Point)"> + <summary> + Put the Sprite at a specified location, using the dimentions of the PictureBox. + You want to use this if you got your X/Y position from a mouse-click. Otherwise, + this is the harder way to track things, particularly if your window can resize. Use + PutBaseImageLocation instead. + </summary> + <param name="NewLocationOnPictureBox">A point on the PictureBox</param> + </member> + <member name="M:SpriteLibrary.Sprite.RecalcPictureBoxLocation"> + <summary> + Done when the box resizes. We need to recompute the picturebox location. The resize function + automatically calls this. You should never need to do so. + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.Tick"> + <summary> + This is run from the sprite controller every 10 miliseconds. You should never + need to call this yourself. + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.GetMoveToSpritePoint(SpriteLibrary.Sprite)"> + <summary> + Return the point that this sprite needs to be shooting for, for the center of this sprite to + hit the center of the destination sprite. + </summary> + <param name="destination">The sprite we are shooting for trying to hit</param> + <returns>A point which allows the moving sprite to collide with the destination sprite.</returns> + </member> + <member name="M:SpriteLibrary.Sprite.SetSize(System.Drawing.Size)"> + <summary> + Resize the sprite using the base image coordinates. The width and height specified + are relative to the size of the background image, not the picturebox. + </summary> + <param name="NewSize">The size (width, height) to make the sprite</param> + </member> + <member name="M:SpriteLibrary.Sprite.Destroy"> + <summary> + Tell the sprite to kill itself. It will erase itself and then + be removed from the spritelist. Then it will be gone forever. + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.HideSprite"> + <summary> + Remove the sprite from the field. This does not destroy the sprite. It simply removes it from action. + Use UnhideSprite to show it again. + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.UnhideSprite"> + <summary> + Make the sprite reappear. If you have not positioned it yet, it will show up at the top corner. It is best to only + use this when you have hidden it using HideSprite + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.SpriteAtPictureBoxPoint(System.Drawing.Point,SpriteLibrary.SpriteCollisionMethod)"> + <summary> + Return true or false, asking if the specifiec sprite is at the point on the picturebox. + You can use this with a mouse-click to see if you are clicking on a sprite. Use the + SpriteCollisionMethod "transparent" to see if you have clicked on an actual pixel of the + sprite instead of just within the sprite rectangle. + </summary> + <param name="location">The x and y location in ImageBox coordinates.</param> + <param name="method">The method of determining if the sprite is at that position</param> + <returns>True if the sprite is at the specified location, false if it is not</returns> + </member> + <member name="M:SpriteLibrary.Sprite.SpriteAdjustedPoint(System.Drawing.Point)"> + <summary> + Because sprites are scaled (shrunk or stretched), this function finds the point + within the sprite that is specified by the location. this function is used by + a number of internal processes, but may be useful to you. But probably not. + </summary> + <param name="location">A point given in Image coordinates</param> + <returns>A point within the pixel that can be used to find a particular pixel in a sprite.</returns> + </member> + <member name="M:SpriteLibrary.Sprite.SpriteAtImagePoint(System.Drawing.Point,SpriteLibrary.SpriteCollisionMethod)"> + <summary> + Check to see if the sprite exists at the point specified. The point given is + in coordinates used by the image (not the PictureBox, use SpriteAtPictureBox for that) + </summary> + <param name="location">An imagebox location</param> + <param name="method">the method to use to determine if the image is there</param> + <returns>true if the sprite is at that position, false if it is not</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetImage"> + <summary> + return the current image frame. Warning: If you write to this image, it will + affect all sprites using this frame. + </summary> + <returns>An image that is the current sprite frame for the current animation</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetImage(System.Int32,System.Int32)"> + <summary> + return the frame for the given index. Warning: If you write to this image, it will + affect all sprites using this frame. + </summary> + <param name="Animation_Index">The Animation index we are trying to find</param> + <param name="Frame_Index">The Frame index we are trying to find</param> + <returns>An image that is the current sprite frame for the current animation</returns> + </member> + <member name="M:SpriteLibrary.Sprite.ReplaceImage(System.Drawing.Image,System.Int32,System.Int32)"> + <summary> + Replace a sprite image. It will replace the current frame unless you specify both an animation + and the frame within the animation you wish to replace. Warning: This replaces the image_frame + for every sprite that uses that is based off the same image. + </summary> + <param name="newimage">The new image to use</param> + <param name="animation">The animation you want to change</param> + <param name="frame">The frame within the animation you want to change</param> + </member> + <member name="M:SpriteLibrary.Sprite.ReturnAdjustmentRatio"> + <summary> + Taking into consideration how the sprite is stretched or shrunk, it + returns a SpriteAdjustmentRatio that can be used to work with the sprite + itself. + </summary> + <returns>The current SpriteAdjustmentRatio used to display this sprite</returns> + </member> + <member name="M:SpriteLibrary.Sprite.SpriteCanMoveOnPictureBox(System.Drawing.Point)"> + <summary> + Return true if the sprite can go to this point and still be on the drawing-board. + </summary> + <param name="newpoint">The point, given in pixels and corresponding to pixels on the picturebox</param> + <returns>true or false</returns> + </member> + <member name="M:SpriteLibrary.Sprite.SpriteCanMoveOnImage(System.Drawing.Point)"> + <summary> + Return true if the sprite can go to this point and still be on the drawing-board. + </summary> + <param name="newpoint">The point, given in pixels and corresponding to pixels on the background image</param> + <returns>true or false</returns> + </member> + <member name="M:SpriteLibrary.Sprite.MoveTo(SpriteLibrary.Sprite)"> + <summary> + Move to where the destination sprite currently is at. This is a dumb move. It does not take into + consideration the movement direction of the destination sprite. So the moving sprite does need to be + moving a bit faster than the sprite you are trying to hit for it to do so. + </summary> + <param name="Destination">The sprite we are trying to hit</param> + </member> + <member name="M:SpriteLibrary.Sprite.MoveTo(System.Drawing.Point)"> + <summary> + Tell the Sprite to move towards a destination. You need to give the sprite a MovementSpeed + and tell the sprite that it can automatically move. But the sprite will begin a journey towards + that point at the MovementSpeed you have set. When it gets to the point, the SpriteArrivedAtEndPoint event + will fire off. Also, the SpriteReachedEnd bool will be true. + </summary> + <param name="Destination">An image-point that the sprite will move to.</param> + </member> + <member name="M:SpriteLibrary.Sprite.MoveTo(System.Collections.Generic.List{System.Drawing.Point})"> + <summary> + Tell the sprite to move towards each point in turn. The sprite will move in a straight line until the first point. + From there it moves to the next point, until it has reached the last point. Every time it reaches a point, the + SpriteArrivedAtWaypoint event is triggered. When it reaches the final point in the list, the SpriteArrivedAtEndPoint + event is triggered. While the sprite is moving, the SpriteReachedEndPoint attribute is set to false. When it has + arrived, it is set to true. + </summary> + <param name="DestinationList">A list of Image-Points that the sprite will follow, one after the other</param> + </member> + <member name="M:SpriteLibrary.Sprite.SetSpriteDirectionToPoint(System.Drawing.Point)"> + <summary> + Sets the Sprite Moving towards a given point. You are responsible to do something with it once it gets there. + If you want it to automatically stop upon reaching it, use MoveTo instead. Actually, the MoveTo function works + a lot better than this one. Because of integer rounding and a few other things, this function is a little + bit imprecise. If you send it towards a point, it will go in that general direction. The MoveTo function + will perpetually recalculate its way to the destination point and actually reach that point. SetSpriteDirectionToPoint + will sort-of head in the direction of the point. But MoveTo will go to that point. + </summary> + <param name="ImagePointDestination">The destination, based off a point on the background image, that we send the sprite towards.</param> + </member> + <member name="M:SpriteLibrary.Sprite.CancelMoveTo"> + <summary> + Cancel a MoveTo command. The sprite will stop moving, and all the waypoints will be removed. + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.SetSpriteDirectionDegrees(System.Double)"> + <summary> + Given a "degree" (from 0 to 360, set the direction + that the sprite moves automatically. 0 is right, 90 is up, 180 is left + and 270 is down. + </summary> + <param name="AngleInDegrees">the degrees to use</param> + </member> + <member name="M:SpriteLibrary.Sprite.SetSpriteDirectionRadians(System.Double)"> + <summary> + Set the sprite direction using Radians. Most people do not want to use this. + Use SetSpriteDirectionDegrees instead unless you like math and know what you + are doing with Radians. + </summary> + <param name="AngleInRadians">The angle in radians</param> + </member> + <member name="M:SpriteLibrary.Sprite.SetSpriteDirection(System.Windows.Vector)"> + <summary> + Set the sprite direction using a vector. The vector may contain + a speed as well as the movement delta (amount of x shift, and amount + of y shift.) If so, this function may also affect the movement speed + Most people prefer to use SetSpriteDirectionDegrees instead of using + vectors. + </summary> + <param name="newVector">A vector</param> + </member> + <member name="M:SpriteLibrary.Sprite.ConvertDegreesToRadians(System.Double)"> + <summary> + Convert a number from degrees to radians. + </summary> + <param name="Degrees">The number from 0 to 360 in degrees</param> + <returns>The corresponding number converted to radians</returns> + </member> + <member name="M:SpriteLibrary.Sprite.ConvertRadiansToDegrees(System.Double)"> + <summary> + Convert a number from radians to degrees. + </summary> + <param name="Radians">The number of radians</param> + <returns>The corresponding number in degrees</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetSpriteVector"> + <summary> + Return the current vector that the sprite is moving along + </summary> + <returns>The current sprite vector</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetSpriteRadans"> + <summary> + Returns the direction the sprite is currently traveling, using Radians. + </summary> + <returns>The direction in radians that the sprite is traveling in</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetSpriteDegrees"> + <summary> + Get the direction that the sprite is traveling in in degrees. You may want to + use Math.Round on the results. The value returned is usually just a tiny bit off + from what you set it with. For example, if you set the sprite movement direction + to be 270 degrees (down), this function may return it as 269.999992. Rounding the + number will give it back to you at probably the same direction you set it as. + </summary> + <returns>A double (it has a decimal place) that represents the direction in degrees</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetSpriteBaseImageCenter"> + <summary> + Return the centerpoint of the sprite, as found on the background image + </summary> + <returns>a point with the x and y based off the background image location</returns> + </member> + <member name="M:SpriteLibrary.Sprite.GetSpritePictureboxCenter"> + <summary> + Return the centerpoint of the sprite, as found on the picturebox + </summary> + <returns>A point with the x and y found on the picturebox</returns> + </member> + <member name="M:SpriteLibrary.Sprite.SpriteIntersectsRectangle(System.Drawing.Rectangle)"> + <summary> + Check to see if the specified rectangle overlaps with the sprite. + </summary> + <param name="target">The rectangle we are looking to see if we hit</param> + <returns>True if the rectangle overlaps the sprite rectabgle</returns> + </member> + <member name="M:SpriteLibrary.Sprite.CheckSpriteHitsSprite(SpriteLibrary.Sprite,SpriteLibrary.SpriteCollisionMethod)"> + <summary> + Check to see if two sprites hit each-other. The sprite collision methods are + not all programmed in. + </summary> + <param name="target">The Sprite we are checking to see if we hit</param> + <param name="how">The method we use to determine if they hit</param> + </member> + <member name="M:SpriteLibrary.Sprite.NoteSpriteHitsSprite(SpriteLibrary.Sprite,SpriteLibrary.SpriteCollisionMethod)"> + <summary> + This is used when two sprites hit each-other. + </summary> + <param name="target">The sprite it hits</param> + <param name="how">the method for checking</param> + </member> + <member name="M:SpriteLibrary.Sprite.SendToFront"> + <summary> + Make the sprite show up in front of all other sprites. + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.SendToBack"> + <summary> + Make the sprite go behind all other sprites + </summary> + </member> + <member name="M:SpriteLibrary.Sprite.Pause(SpriteLibrary.SpritePauseType)"> + <summary> + Pause the sprite. We can pause just the animation (and still let it move), pause movement (and let it animate), or pause everything. + </summary> + <param name="What">Which aspects of the sprite you want to pause.</param> + </member> + <member name="M:SpriteLibrary.Sprite.UnPause(SpriteLibrary.SpritePauseType)"> + <summary> + unpause the sprite. + </summary> + <param name="What">Which aspects of the sprite you want to unpause.</param> + </member> + <member name="M:SpriteLibrary.Sprite.IsPaused(SpriteLibrary.SpritePauseType)"> + <summary> + Ask if the sprite is paused using the specified sprite type (default is PauseAll) + </summary> + <param name="What">The spritePauseType to see if the sprite is paused with</param> + <returns>True if the sprite is set to pause the specified item, false if not</returns> + </member> + <member name="T:SpriteLibrary.NamespaceDoc"> + <summary> + SpriteLibrary is a .net graphical library for creating and controlling sprites on a PictureBox. + + A sprite is an animated image that can be moved around on a + picturebox. You can give the sprite an initial location, and either move it around manually or give it + specific movement controls. + + To use this library, you will need to add a reference to it in your project. You will also need a reference to + "Windows Base." + In the solution explorer, if you right-click your project and go to "add", and then "reference" and click + "WindowsBase" towards the bottom. + On that same window, on the left, click "browse." Then, click the "Browse..." button and find the sprite-library dll. + The main places to find the SpriteLibrary and sample programs using this SpriteLibrary are here: + <see href="http://www.codeproject.com/Articles/1085446/Using-Sprites-Inside-Windows-Forms"/> + and + <see href="http://tyounglightsys.ddns.info/SpriteLibrary"/> + </summary> + </member> + <member name="T:SpriteLibrary.SpriteCollisionMethod"> + <summary> + The various types of collisions a sprite can have. Currently only rectangle works. The other types were added when I + thought the different types of collision types were needed. Someday we may add these if we find they are useful, or if + someone else decides they want to help program the SpriteLibrary. These values are primarily used in Sprite Events + </summary> + </member> + <member name="F:SpriteLibrary.SpriteCollisionMethod.rectangle"> + <summary> + Checks if the two rectangles that contain the sprites overlap. Each rectangle is the starting location of the sprite + (top left) with the sprite width, and height marking the other sides of the rectangle. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteCollisionMethod.circle"> + <summary> + Draws a circle (ellipse) inside the sprite rectangles and see if those ellipses overlap + </summary> + </member> + <member name="F:SpriteLibrary.SpriteCollisionMethod.transparency"> + <summary> + Check to see if nontransparent portions of a sprite collide. Not working. + </summary> + </member> + <member name="T:SpriteLibrary.SpriteAdjustmentRatio"> + <summary> + A structure that contains the width and height adjustment ratio. Use this if you need to manually calculate positions + between the PictureBox that the sprite is in, and the Background Image itself. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteAdjustmentRatio.width_ratio"> + <summary> + Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteAdjustmentRatio.height_ratio"> + <summary> + Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. + </summary> + </member> + <member name="T:SpriteLibrary.SpritePauseType"> + <summary> + The type of pause signals you can give a sprite or the sprite controller + </summary> + </member> + <member name="F:SpriteLibrary.SpritePauseType.PauseAnimation"> + <summary> + Pause the animating. Animation resumes from the current frame when we unpause. A paused animation will continue + to display the same image frame until it is unpaused. + </summary> + </member> + <member name="F:SpriteLibrary.SpritePauseType.PauseMovement"> + <summary> + Pause any automatic movement. Movement resumes where it was left off if you unpause. The sprite will + just sit there until unpaused. + </summary> + </member> + <member name="F:SpriteLibrary.SpritePauseType.PauseEvents"> + <summary> + Pause events. Sprite collisions, movement checks, etc are stopped until the unpause. + </summary> + </member> + <member name="F:SpriteLibrary.SpritePauseType.PauseAll"> + <summary> + All pausable things are paused. PauseAnimation, PauseMovement, and PauseEvents. + </summary> + </member> + <member name="T:SpriteLibrary.SpriteController"> + <summary> + A sprite controller is the main heart of the sprite class. Each SpriteController manages one picturebox. + If at all possible, try to keep each game in one picturebox, and try to avoid making and destroying + new forms with SpriteController/pictureboxes in them. It is hard to destroy them completely. + </summary> + <example> + A sprite controller controls animations and + can help you check for <see cref="M:SpriteLibrary.SpriteController.IsKeyPressed(System.Windows.Forms.Keys)">key-presses.</see> To make a sprite controller, + you need to have one defined for your main form: + <code language="C#"> + SpriteController MySpriteController; + </code> + And then, when the form is created, after the InitializeComponents() function, you + need to configure the drawing area and create the sprite controller: + <code language="C#"> + MainDrawingArea.BackgroundImage = Properties.Resources.Background; + MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + MySpriteController = new SpriteController(MainDrawingArea); + </code> + In this case, MainDrawingArea is the picturebox where all the sprites will be displayed. + </example> + </member> + <member name="F:SpriteLibrary.SpriteController.RandomNumberGenerator"> + <summary> + Since everything needs a random number generator, we make one that should be accessible throughout your program. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteController.InvalidateList"> + <summary> + This is only used by the SpriteController. It allows us to queue up invalidation requests. + </summary> + </member> + <member name="P:SpriteLibrary.SpriteController.SpriteCount"> + <summary> + The count of all the sprites the controller knows about. This includes named + sprites, which may not be visible. + </summary> + </member> + <member name="F:SpriteLibrary.SpriteController.OptimizeForLargeSpriteImages"> + <summary> + If your sprite images need substantial growing or shrinking when displayed, you can try setting this to "true" + to see if it makes it run any faster. What it does is to resize the image once, and keep a cached copy of that + image at that size. If you use the same sprite, but with different sizes, setting this to "True" may actually slow + down the game instead of speeding it up. + </summary> + </member> + <member name="M:SpriteLibrary.SpriteController.#ctor(System.Windows.Forms.PictureBox)"> + <summary> + Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. You want to have the PictureBox already defined, and a background image + already set for the PictureBox. + </summary> + <example> + This is an example of a Form class that defines a SpriteController. The MainDrawingArea is a + <see cref="T:System.Windows.Forms.PictureBox">PictureBox.</see> + <code lang="C#"> + public partial class ShootingFieldForm : Form + { + public ShootingFieldForm() + { + InitializeComponent(); + MainDrawingArea.BackgroundImage = Properties.Resources.Background; + MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + MySpriteController = new SpriteController(MainDrawingArea); + } + } + </code> + </example> + <param name="Area">The <see cref="T:System.Windows.Forms.PictureBox">PictureBox.</see> + that the sprites will be drawn in</param> + </member> + <member name="M:SpriteLibrary.SpriteController.#ctor(System.Windows.Forms.PictureBox,System.EventHandler)"> + <summary> + Create a sprite controller, specifying the picturebox on which the sprites + will be displayed. + </summary> + <example> + This is an example of a Form class that defines a SpriteController. The MainDrawingArea is a + <see cref="T:System.Windows.Forms.PictureBox">PictureBox.</see> While defining the SpriteController, we + are also setting a function used for the <see cref="E:SpriteLibrary.SpriteController.DoTick">DoTick.</see> event. + <code lang="C#"> + public partial class ShootingFieldForm : Form + { + public ShootingFieldForm() + { + InitializeComponent(); + MainDrawingArea.BackgroundImage = Properties.Resources.Background; + MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + MySpriteController = new SpriteController(MainDrawingArea, CheckForKeyPress); + } + + private void CheckForKeyPress(object sender, EventArgs e) + { + //Do stuff here + } + } + + </code> + </example> + <param name="Area">The picturebox that the sprites will be drawn in</param> + <param name="TimerTickMethod">A function on the form that you want to have run every tick</param> + </member> + <member name="M:SpriteLibrary.SpriteController.Local_Setup"> + <summary> + Define some things and set up some things that need defining at instantiation + </summary> + </member> + <member name="M:SpriteLibrary.SpriteController.ChangeTickInterval(System.Int32)"> + <summary> + Change the Tick Interval. By default, the spritecontroller does a tick every 10ms, which + is very fast. Some people may prefer it to happen less regularly. Must be > 5, and less than 1001 + </summary> + <param name="newTickMilliseconds">The new tick interval</param> + </member> + <member name="F:SpriteLibrary.SpriteController.SpriteComparisonDelegate"> + <summary> + Allow the sprite sort-method to be overridden. + </summary> + <example> + The default sprite sort method is: + <code lang="C#"> + SpriteComparisonDelegate = delegate (Sprite first, Sprite second) { return first.Zvalue.CompareTo(second.Zvalue); }; + </code> + Which compares just the Zvalues of the two sprites. Often you will want to have a more refined sort. The sort + order determines which sprites appear on top of other sprites. In the default state, if two sprites have the + same Zvalue, it is very uncleaer which one will draw on top of the other one. By overridding this sort function, + you can specify a very precise order of which sprite is on top and which is behind. + </example> + </member> + <member name="M:SpriteLibrary.SpriteController.MouseClickOnBox(System.Object,System.Windows.Forms.MouseEventArgs)"> + <summary> + This is what happens when someone clicks on the PictureBox. We want to pass any Click events to the Sprite + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SpriteLibrary.SpriteController.MouseHover(System.Object,System.EventArgs)"> + <summary> + Check to see if we are hovering over anything + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SpriteLibrary.SpriteController.ReplaceOriginalImage(System.Drawing.Image)"> + <summary> + Replace the image on which the sprites are drawn. Use this when you move to a new playing field, + or want to have a different background + <example> + Replacing the background image is actually a lot more complex than you might imagine. Once you use the + below code, it can be done without any problem. But you need to do it this way, or it just goofs up in + a number of small ways. + You need to tell the sprite controller that you are replacing the background image, + and you need to change the image to that image as well.Because the Images are actually + pointers to memory where the image sets, changes to one image will affect the other image.This goofs + things up, so what we do is duplicate the image twice, and tell the sprite controller to use one of the + copies and then set the background to be the other one of the two copies.Finally, we tell the picturebox + to invalidate itself.That does everything that is needed. + <code lang="C#"> + void ReplaceBackground(Image NewBackground) + { + if (MyController == null) return; + if (NewBackground == null) return; + + Image OneImage = new Bitmap(NewBackground); + MyController.ReplaceOriginalImage(OneImage); + + Image TwoImage = new Bitmap(NewBackground); + pb_map.BackgroundImage = TwoImage; + pb_map.Invalidate(); + } + </code> + </example> + </summary> + <param name="tImage">The new image that all sprites will be drawn on</param> + </member> + <member name="M:SpriteLibrary.SpriteController.ReplaceOriginalImage"> + <summary> + Notify the sprite controller that you have changed the background image on the + PictureBox. Whatever background is on the picturebox is now used to draw all the sprites on. + </summary> + </member> + <member name="M:SpriteLibrary.SpriteController.TimerTick(System.Object,System.EventArgs)"> + <summary> + The function called by the timer every 10 millisecods We also call do_tick, which + is the function defined by the user. This is usually where they will do the majority of the work. + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="E:SpriteLibrary.SpriteController.DoTick"> + <summary> + The function called by the timer every 10 millisecods This is usually where you will do the majority of the work. + You can define this manually, or when you <see cref="M:SpriteLibrary.SpriteController.#ctor(System.Windows.Forms.PictureBox,System.EventHandler)">instantiate the SpriteController</see> + </summary> + <example> + The Sprite controller uses a <see cref="T:System.Windows.Forms.Timer">System.Windows.Forms.Timer.</see> This timer is notoriously un-precise, but it is very + easy to set up initially. It tries to fire off every 10 milliseconds, but it can fire off incredibly + slowly if you have long pieces of code; the DoTick function needs to finish before it can start again. You want all your + functions to run as quickly as possible to avoid things looking jerky. + Most programs you will make using the sprite library will begin by tapping into the DoTick Event. + Every time the sprite controller is ready to pass control back to your program, it will call + the DoTick event. You want to see if you should be doing anything, and then exiting the do-tick function. + <code lang = "C#"> + public partial class ShootingFieldForm : Form + { + public ShootingFieldForm() + { + InitializeComponent(); + MainDrawingArea.BackgroundImage = Properties.Resources.Background; + MainDrawingArea.BackgroundImageLayout = ImageLayout.Stretch; + MySpriteController = new SpriteController(MainDrawingArea, CheckForKeyPress); + } + + private void CheckForKeyPress(object sender, EventArgs e) + { + bool left = false; + bool right = false; + bool space = false; + bool didsomething = false; + TimeSpan duration = DateTime.Now - LastMovement; + if (duration.TotalMilliseconds < 100) + return; + LastMovement = DateTime.Now; + if (MySpriteController.IsKeyPressed(Keys.A) || MySpriteController.IsKeyPressed(Keys.Left)) + { + left = true; + } + if (MySpriteController.IsKeyPressed(Keys.D)||MySpriteController.IsKeyPressed(Keys.Right)) + { + right = true; + } + if (left && right) return; //do nothing if we conflict + if (left) + { + if (LastDirection != MyDir.left) + { + Spaceship.SetSpriteDirectionDegrees(180); + //We want to only change animation once. Every time we change + //the animation, it starts at the first frame again. + Spaceship.ChangeAnimation(0); + LastDirection = MyDir.left; + } + didsomething = true; + Spaceship.MovementSpeed = 15; + Spaceship.AutomaticallyMoves = true; + } + if (right) + { + if (LastDirection != MyDir.right) + { + Spaceship.SetSpriteDirectionDegrees(0); + Spaceship.ChangeAnimation(0); + LastDirection = MyDir.right; + } + didsomething = true; + Spaceship.AutomaticallyMoves = true; + Spaceship.MovementSpeed = 15; + } + if(!didsomething) + { + LastDirection = MyDir.stopped; + //No keys pressed. Stop moving + Spaceship.MovementSpeed = 0; + } + } + </code> + </example> + </member> + <member name="M:SpriteLibrary.SpriteController.ProcessImageResize(System.Object,System.EventArgs)"> + <summary> + Process a form resize by recalculating all the picturebox locations for all sprites. + </summary> + <param name="sender">The form</param> + <param name="e">Form event args</param> + </member> + <member name="M:SpriteLibrary.SpriteController.CountSpritesBasedOff(System.String)"> + <summary> + Count the number of sprites that were duplicated from the sprite with the specified name. When you use a + <see cref="M:SpriteLibrary.SpriteController.DuplicateSprite(System.String)">SpriteController.DuplicateSprite(string)</see> + command, it creates a new sprite that is based off the named sprite. This function will count those duplicated sprites. + </summary> + <param name="Name">The name to look for</param> + <returns>The count of sprites that are duplicates of the specified name</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.AllSprites"> + <summary> + Return a list of all sprites + </summary> + <returns>A list of all sprites</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.SpritesBasedOff(System.String)"> + <summary> + Return all sprites that were based off a particular sprite name. + When you use a + <see cref="M:SpriteLibrary.SpriteController.DuplicateSprite(System.String)">SpriteController.DuplicateSprite(string)</see> + command, it creates a new sprite that is based off the named sprite. This function returns a list of those + duplicated sprites. + </summary> + <param name="SpriteName">The sprite name to find</param> + <returns>A list of sprites that were based off the named sprite</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.SpritesThatHaveBeenDrawn"> + <summary> + Return a list of all sprites which have been drawn on the image + </summary> + <returns>A list of sprites that have been drawn</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.SpritesBasedOffAnything"> + <summary> + Return a list of all sprites which are not master sprites (which are duplicates of something) + </summary> + <returns>A list of sprites</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.ReturnAdjustmentRatio"> + <summary> + Return an adjustment ratio. This is the image-size to picture-box ratio. + It is used for calculating precise pixels or picture-box locations. + </summary> + <returns>A SpriteAdjustmentRatio containing the current ratio of picture-box pixels to image-box pixels</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.ReturnPointAdjustedForImage(System.Drawing.Point)"> + <summary> + This takes a point, the location on a picturebox, and returns the corresponding point on the BackgroundImage. + Picturebox locations are "sloppy"; the background image locations are very precise. Since this takes a "sloppy" + number and returns a precise number, it does some rounding to figure out where the specified location is. + </summary> + <param name="LocationOnPicturebox">A point on the picturebox that you want the corresponding image pixel location for.</param> + <returns>A point (x,y) on the background image which corresponds to the picture-box coordinates you sent into the function.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.ReturnPictureBoxAdjustedHeight(System.Int32)"> + <summary> + Return the height of an object in picture-box terms. It is basically the virtual height + of the sprite or other item. + </summary> + <param name="Height">The image-box heigh (or sprite height)</param> + <returns>An integer that corresponds to the hight as displayed in the picturebox</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.ReturnPictureBoxAdjustedWidth(System.Int32)"> + <summary> + Return the width of an object in picture-box terms. It takes the width of a sprite or other + item that is being displayed on the screen, and calculates the width as displayed in the + picture-box (taking into consideration stretching or shrinking) + </summary> + <param name="Width">An integer width of the drawn item</param> + <returns>An integer that contains the number of pixels wide it is on the picturebox</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.ReturnPictureBoxAdjustedPoint(System.Drawing.Point)"> + <summary> + This does the reverse of an adjusted point. It takes a point on the image and + transforms it to one on the PictureBox + </summary> + <param name="LocationOnImage">A point on the image, using the x and y pixels on the image</param> + <returns>A location that can be used on the picture-box, taking into consideration the image being stretched.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.AdjustRectangle(System.Drawing.Rectangle)"> + <summary> + Adjust a rectangle that is based on the image, according to the stretch of the picturebox + </summary> + <param name="ImageRectangle">A rectangle using coordinates from the image</param> + <returns>a rectangle that is adjusted for the PictureBox</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.AdjustPoint(System.Drawing.Point)"> + <summary> + Adjust an image point so that it conforms to the picturebox. + </summary> + <param name="LocationOnImage">The image location</param> + <returns>the corresponding point on the PictuerBox</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.Invalidate(System.Drawing.Rectangle,System.Boolean)"> + <summary> + Invalidate a rectangle that is specified in image coordinates + </summary> + <param name="ImageRectangle">A rectangle based on the image coordinates</param> + <param name="QueueUpInvalidation">Whether to do it now, or to queue it up for another time.</param> + </member> + <member name="M:SpriteLibrary.SpriteController.Invalidate(System.Boolean)"> + <summary> + Invalidate the entire image on which the sprites are drawn + </summary> + <param name="QueueUpInvalidation">Whether to do it now, or to queue it up for another time.</param> + </member> + <member name="P:SpriteLibrary.SpriteController.BackgroundImage"> + <summary> + The Background Image on which the sprites are drawn. This image ends up having + sprite parts on it. The OriginalImage is the version that is clean. Use + ReplaceOriginalImage to replace the background Image. + </summary> + </member> + <member name="P:SpriteLibrary.SpriteController.OriginalImage"> + <summary> + The Image from which the background is taken when we erase sprites. The BackgroundImage + is the image that contains images of the sprites as well as the background image. Use + ReplaceOriginalImage to replace this and the BackgroundImage. + </summary> + </member> + <member name="M:SpriteLibrary.SpriteController.DuplicateSprite(SpriteLibrary.Sprite)"> + <summary> + Make a duplicate of the specified sprite. The duplicate does not yet have a location. + </summary> + <param name="What">The sprite to duplicate</param> + <returns>A new sprite. If What is null, returns null</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.DuplicateSprite(System.String)"> + <summary> + Find a sprite that has been named with the specified name. Then duplicate that sprite + </summary> + <example> + Below is a function that creates a sprite based off a name, and puts it at the designated coordinates. + <code lang="C#"> + public void AddSprite(string name, int startx, int starty) + { + Sprite NewSprite = MySpriteController.DuplicateSprite(What.ToString()); + if(NewSprite != null) + { + NewSprite.AutomaticallyMoves = true; + NewSprite.CannotMoveOutsideBox = true; + NewSprite.SetSpriteDirectionDegrees(180); //left + NewSprite.PutBaseImageLocation(new Point(startx, starty)); + NewSprite.MovementSpeed = 5; + } + } + </code> + </example> + <param name="Name">The name of a sprite</param> + <returns>A duplicate of the specified sprite. It has no location, and does not retain the sprite name.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.SpriteFromName(System.String)"> + <summary> + Find a sprite that has a specified name. This returns the actual sprite with that name. + You usually want to use DuplicateSprite(Name) to clone the sprite and get one you can + destroy. If you destroy a named sprite without duplicating it, you may end up losing + it for the remainder of the program. + </summary> + <param name="Name">A string that matches something added to a sprite with Sprite.SetName</param> + <returns>A sprite that has the specified name, or null if no such sprite exists.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.AddSprite(SpriteLibrary.Sprite)"> + <summary> + Add the specified sprite to the list of sprites we know about. You usually do not need to do this. + Sprites add themselves to the controller when you create a new sprite. + </summary> + <param name="SpriteToAdd">The sprite to add to the sprite-controller</param> + </member> + <member name="M:SpriteLibrary.SpriteController.DestroySprite(SpriteLibrary.Sprite)"> + <summary> + Tell a sprite to destroy itself. The sprite will have Destroying property set to true from + the time you destroy it until it vanishes. Whe you destroy a sprite, it will erase itself + and remove itself from the controller. After it is destroyed, it is completely gone. + </summary> + <param name="what">The Sprite to destroy</param> + </member> + <member name="M:SpriteLibrary.SpriteController.DestroyAllSprites"> + <summary> + Remove all sprites (even named sprites that have not yet been displayed) + </summary> + </member> + <member name="M:SpriteLibrary.SpriteController.NameSprite(SpriteLibrary.Sprite,System.String)"> + <summary> + Find the specified Sprite in the controller and change its name to the specified string. + You can do the same thing with <see cref="M:SpriteLibrary.Sprite.SetName(System.String)">Sprite.SetName(Name)</see> + </summary> + <param name="What">The Sprite to find</param> + <param name="Name">The string to change the name to</param> + </member> + <member name="M:SpriteLibrary.SpriteController.SpritesAtPoint(System.Drawing.Point)"> + <summary> + This takes a point, as given by the mouse-click args, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the picturebox coordinates. So you can use this directly from a MouseDown or MouseUp function. + </summary> + <param name="Location">The picture-box point being clicked on</param> + <returns>A list of sprites that are all at the specified point.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.SpritesAtImagePoint(System.Drawing.Point)"> + <summary> + This takes a point, as as specified on the image, and returns the sprites at that point. Different + functions use different coordinates, whether based off the background image, or based off the picturebox. + This one uses the background image coordinates. Use SpritesAdPoint() if you are doing something based off + a MouseUp or MouseDown function. This is used for functions based on sprite location or based off the absoloute + location (using the background image location is much more precise than the visible location in the picturebox) + </summary> + <param name="Location">The point being looked at</param> + <returns>A list of sprites that are all at the specified image point</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.SpritesInImageRectangle(System.Drawing.Rectangle)"> + <summary> + Return a list of all the sprites that intersect with the given background-image-based rectangle + </summary> + <param name="Location">The rectangle on the image we are trying to find</param> + <returns>A list of the sprites that have any portion of it inside the rectangle</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.IsKeyPressed"> + <summary> + Check to see if any keys are pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. + </summary> + <returns>True if a key is pressed, false if no keys are pressed.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.KeysPressed"> + <summary> + Return a list of all the keys that are currently pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. + </summary> + <returns>A List of Keys which are currently considered to be pressed.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.IsKeyPressed(System.Windows.Forms.Keys)"> + <summary> + Check to see if the given key is pressed. There is a small glitch with the + key-pressed system. If the form loses focus, and someone releases a key, the key-up is never + triggered. It is a good thing to ResetKeypressState() occasionally if you think your form may have + lost focus. + </summary> + <param name="k">The key to check to see if it is pressed</param> + <returns>True if the key is pressed, false if that key is not pressed</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.RegisterKeyDownFunction(SpriteLibrary.SpriteKeyEventHandler)"> + <summary> + If you want to have a KeyDown function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) + </summary> + <param name="Func">The function to set</param> + </member> + <member name="M:SpriteLibrary.SpriteController.RegisterKeyUpFunction(SpriteLibrary.SpriteKeyEventHandler)"> + <summary> + If you want to have a KeyUp function that is triggered by a keypress function, add the event here. + The event should have the parameters (object sender, KeyEventArgs e) + </summary> + <param name="Func">The function to set</param> + </member> + <member name="M:SpriteLibrary.SpriteController.ResetKeypressState"> + <summary> + Reset the keypress status. Sometimes the sprite controller misses a key being released (usually + because a window has taken priority, or something has changed). Calling this function will reset + the stored memory of whether a key has been pressed. + </summary> + </member> + <member name="M:SpriteLibrary.SpriteController.SpriteToFront(SpriteLibrary.Sprite)"> + <summary> + Change the display order of the specified sprite so it goes in front of all other sprites. + </summary> + <param name="What">The sprite we want to show up in front</param> + </member> + <member name="M:SpriteLibrary.SpriteController.SpriteToBack(SpriteLibrary.Sprite)"> + <summary> + Change the display order of the specified sprite so it goes behind all other sprites. + </summary> + <param name="What">The sprite to send behind all other sprites</param> + </member> + <member name="M:SpriteLibrary.SpriteController.SpriteBackwards(SpriteLibrary.Sprite)"> + <summary> + Change the display order of the specified sprite so it is more likely to go behind all other sprites. + </summary> + <param name="What">The sprite to send behind all other sprites</param> + </member> + <member name="M:SpriteLibrary.SpriteController.SpriteForwards(SpriteLibrary.Sprite)"> + <summary> + Change the display order of the specified sprite so it is more likely to go in front of other sprites + </summary> + <param name="What">The sprite to send behind all other sprites</param> + </member> + <member name="M:SpriteLibrary.SpriteController.PlaceSpriteBehind(SpriteLibrary.Sprite,SpriteLibrary.Sprite)"> + <summary> + Change the display order of the sprites such that the specified sprite appears behind the other sprite. + </summary> + <param name="WhatToSend">The sprite we are changing the display order of</param> + <param name="ToGoBehind">The sprite we want to go behind</param> + </member> + <member name="M:SpriteLibrary.SpriteController.PlaceSpriteInFrontOf(SpriteLibrary.Sprite,SpriteLibrary.Sprite)"> + <summary> + Make the sprite go in front of the specified sprite. + </summary> + <param name="WhatToSend">The sprite to change the display order of</param> + <param name="ToGoInFrontOf">The sprite we want to make sure we display in front of</param> + </member> + <member name="M:SpriteLibrary.SpriteController.SoundPlay(System.IO.Stream,System.String)"> + <summary> + Play a sound that we can check to see if it has completed. + </summary> + <param name="ToPlay">The sound to play</param> + <param name="Name">The name, which we can use to determine if it has finished.</param> + </member> + <member name="M:SpriteLibrary.SpriteController.PlayAsync(System.IO.Stream,System.String,System.EventHandler)"> + <summary> + Play a sound bit in a separate thread. When the thread is done, set a bool saying that + </summary> + <param name="ToPlay">The sound to play</param> + <param name="RegisterName">The string that we can use to track the status of the sound</param> + <param name="WhenDone">A function that gets called when the sound is complete</param> + </member> + <member name="M:SpriteLibrary.SpriteController.SoundIsFinished(System.String)"> + <summary> + Check to see if the specified sound has finished playing + </summary> + <param name="Name">The name of the sound</param> + <returns>True if the sound is not currently playing. False if it is currently playing.</returns> + </member> + <member name="M:SpriteLibrary.SpriteController.Pause(SpriteLibrary.SpritePauseType)"> + <summary> + Pause everything. It loops through all the sprites in the SpriteController and sends the specified + SpritePauseType to each one. Look at the documentation for SpritePauseType to determine which pause + type to use. + </summary> + <param name="What">The SpritePauseType to send all sprites</param> + </member> + <member name="M:SpriteLibrary.SpriteController.UnPause(SpriteLibrary.SpritePauseType)"> + <summary> + un-Pause everything. This will send the specified SpritePauseType unpause command + to all sprites. + </summary> + <param name="What">The SpritePauseType to unpause for all sprites</param> + </member> + <member name="T:SpriteLibrary.SpritePayload"> + <summary> + The SpritePayload is a stub of a class, for storing user-defined data and functions along with a sprite. + </summary> + <example> + Basically, you want to "override" this class. You do this by making your + own class that looks something like: + <code lang="C#"> + public class TankPayload : SpritePayload + { + public int Armor = 20; + public int FireTime = 100; + } + </code> + And then you add that to your sprite: + <code lang="C#">TankSprite.Payload = new TankPayload(); </code> + If there is no payload, then the payload + property is null. If you have multiple types of SpritePayloads, you may need to do something like: + <code lang="C#"> + if(TankSprite.payload != null and TankSprite.payload is TankPayload) + { + TankPayload tPayload = (TankPayload)TankSprite.payload; tPayload.Armor--; + } + </code> + </example> + </member> + </members> +</doc> diff --git a/SpriteLibrary/bin/Release/SpriteLibrary.dll b/SpriteLibrary/bin/Release/SpriteLibrary.dll new file mode 100644 index 0000000..eaa3011 Binary files /dev/null and b/SpriteLibrary/bin/Release/SpriteLibrary.dll differ diff --git a/SpriteLibrary/bin/Release/SpriteLibrary.pdb b/SpriteLibrary/bin/Release/SpriteLibrary.pdb new file mode 100644 index 0000000..67db46b Binary files /dev/null and b/SpriteLibrary/bin/Release/SpriteLibrary.pdb differ diff --git a/SpriteLibrary/obj/Release/CoreCompileInputs.cache b/SpriteLibrary/obj/Release/CoreCompileInputs.cache new file mode 100644 index 0000000..e8c1fbc --- /dev/null +++ b/SpriteLibrary/obj/Release/CoreCompileInputs.cache @@ -0,0 +1 @@ +a8cf27034d92fac0fcc617c33163b8923a432866 diff --git a/SpriteLibrary/obj/Release/DesignTimeResolveAssemblyReferences.cache b/SpriteLibrary/obj/Release/DesignTimeResolveAssemblyReferences.cache new file mode 100644 index 0000000..cbb9a6f Binary files /dev/null and b/SpriteLibrary/obj/Release/DesignTimeResolveAssemblyReferences.cache differ diff --git a/SpriteLibrary/obj/Release/DesignTimeResolveAssemblyReferencesInput.cache b/SpriteLibrary/obj/Release/DesignTimeResolveAssemblyReferencesInput.cache new file mode 100644 index 0000000..c8ba4b3 Binary files /dev/null and b/SpriteLibrary/obj/Release/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/SpriteLibrary/obj/Release/SpriteLibrary.Properties.Resources.resources b/SpriteLibrary/obj/Release/SpriteLibrary.Properties.Resources.resources new file mode 100644 index 0000000..341c9a4 Binary files /dev/null and b/SpriteLibrary/obj/Release/SpriteLibrary.Properties.Resources.resources differ diff --git a/SpriteLibrary/obj/Release/SpriteLibrary.csproj.FileListAbsolute.txt b/SpriteLibrary/obj/Release/SpriteLibrary.csproj.FileListAbsolute.txt new file mode 100644 index 0000000..f11d8da --- /dev/null +++ b/SpriteLibrary/obj/Release/SpriteLibrary.csproj.FileListAbsolute.txt @@ -0,0 +1,8 @@ +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\bin\Release\SpriteLibrary.XML +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\bin\Release\SpriteLibrary.dll +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\bin\Release\SpriteLibrary.pdb +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\obj\Release\SpriteLibrary.Properties.Resources.resources +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\obj\Release\SpriteLibrary.csproj.GenerateResource.Cache +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\obj\Release\SpriteLibrary.dll +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\obj\Release\SpriteLibrary.pdb +C:\Users\TimYo\Documents\Visual Studio 2015\Projects\SpriteLibrary\SpriteLibrary\obj\Release\SpriteLibrary.csprojResolveAssemblyReference.cache diff --git a/SpriteLibrary/obj/Release/SpriteLibrary.csproj.GenerateResource.Cache b/SpriteLibrary/obj/Release/SpriteLibrary.csproj.GenerateResource.Cache new file mode 100644 index 0000000..b0737c4 Binary files /dev/null and b/SpriteLibrary/obj/Release/SpriteLibrary.csproj.GenerateResource.Cache differ diff --git a/SpriteLibrary/obj/Release/SpriteLibrary.csprojResolveAssemblyReference.cache b/SpriteLibrary/obj/Release/SpriteLibrary.csprojResolveAssemblyReference.cache new file mode 100644 index 0000000..1c09120 Binary files /dev/null and b/SpriteLibrary/obj/Release/SpriteLibrary.csprojResolveAssemblyReference.cache differ diff --git a/SpriteLibrary/obj/Release/SpriteLibrary.dll b/SpriteLibrary/obj/Release/SpriteLibrary.dll new file mode 100644 index 0000000..eaa3011 Binary files /dev/null and b/SpriteLibrary/obj/Release/SpriteLibrary.dll differ diff --git a/SpriteLibrary/obj/Release/SpriteLibrary.pdb b/SpriteLibrary/obj/Release/SpriteLibrary.pdb new file mode 100644 index 0000000..67db46b Binary files /dev/null and b/SpriteLibrary/obj/Release/SpriteLibrary.pdb differ diff --git a/SpriteLibrary/obj/Release/TempPE/Properties.Resources.Designer.cs.dll b/SpriteLibrary/obj/Release/TempPE/Properties.Resources.Designer.cs.dll new file mode 100644 index 0000000..b8a9f28 Binary files /dev/null and b/SpriteLibrary/obj/Release/TempPE/Properties.Resources.Designer.cs.dll differ diff --git a/SpriteLibrary/obj/Release/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs b/SpriteLibrary/obj/Release/TemporaryGeneratedFile_036C0B5B-1481-4323-8D20-8F5ADCB23D92.cs new file mode 100644 index 0000000..e69de29 diff --git a/SpriteLibrary/obj/Release/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs b/SpriteLibrary/obj/Release/TemporaryGeneratedFile_5937a670-0e60-4077-877b-f7221da3dda1.cs new file mode 100644 index 0000000..e69de29 diff --git a/SpriteLibrary/obj/Release/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs b/SpriteLibrary/obj/Release/TemporaryGeneratedFile_E7A71F73-0F8D-4B9B-B56E-8E70B10BC5D3.cs new file mode 100644 index 0000000..e69de29

+ +	Name	Description
	Equals	Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
	GetHashCode	Returns the hash code for this instance. (Inherited from ValueType.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

+ +	Name	Description
	Sprite(Sprite, Boolean)	+ Create a Sprite that is based off of the specified sprite. Clone the Sprite except that + we set SpriteName = "" and OrigSpriteName = the OldSprite.SpriteName. That way we know that + the sprite was duplicated from the original, and we can still distinguish the original from + the duplicate. +
	Sprite(SpriteController, Image)	+ Generate a new single-frame sprite from the specified image. +
	Sprite(SpriteController, Image, Size)	+ Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width + and height in the image, an animation is created. +
	Sprite(SpriteController, Image, Int32, Int32)	+ Generate a new sprite. It takes the image and the width and height. If there are multiple images of that width + and height in the image, an animation is created. +
	Sprite(SpriteController, Image, Int32, Int32, Int32)	+ Generate a new sprite. It takes a width, height, and the duration in Milliseconds for each frame +
	Sprite(Point, SpriteController, Image, Int32, Int32, Int32, Int32)	+ Create a Sprite from an animation image, specifying the number of consecutive + frames to grab. +

+ +	Name	Description
	AnimationCount	+ The number of animations this sprite has +
	AnimationDone	+ Report whether or not the animation has been completed. When you tell a Sprite to AnimateOnce, + this will report "false" until the animation sequence has been finished. At that time, the value + will be "True." The tricky bit is that this is a boolean. If you have not told a sprite to + animate once, it will always return "false." If a sprite is paused, this returns "false." The only + time this returns "true" is when you tell a sprite to animate once, or animate a few times, and those + times have completed. At that time, this will report "True". If you have a sprite with only one frame, + it may not look like it is "animating", but it is. It is simply animating that one frame over and over. + So, AnimationDone reports false, unless you have told it to animate_once. +
	AnimationIndex	+ Get or set the animation nimber. It is best to change the animation using ChangeAnimation. + It is safer. +
	AutomaticallyMoves	+ Determine if the sprite automatically moves (you need to give it a direction [using one of the + SetSpriteDirection functions] and speed [MovementSpeed = X] also) +
	BaseImageLocation	+ The sprite location as found on the base image. This is usually the easiest location to use. +
	Destroying	+ If the Sprite is in the middle of being Destroyed, this is set to true. When a Sprite is + Destroyed, it needs to erase itself and do some house-cleaning before it actually vanishes. + During this time, you may not want to use it. It is always a good thing to verify a Sprite + is not in the middle of being destroyed before you do something important with it. To Destroy + a Sprite, use the Sprite.Destroy() function. +
	FrameIndex	+ This is the frame of the current animation sequence. You can use this if you need to figure out what frame index + to resume something at, or something like that. +
	GetSize	+ Return the size of the sprite in reference to the image on which it is drawn. To get the + size of the Sprite in relation to the PictureBox, use GetVisibleSize +
	GetVisibleSize	+ Return the relative size of the Sprite in relation to the PictureBox. If the box has been + stretched or shrunk, that affects the visible size of the sprite. +
	HasBeenDrawn	+ Report whether or not this Sprite has been drawn. If it has, then it needs to be erased at + some point in time. +
	ID	+ The Sprite ID as specified by the sprite controller. +
	MovingToPoint	+ Tells us if we are in the process of doing a MoveTo operation. This boolean should be the + opposite of SpriteReachedEndpoint, but that boolean is poorly named. This is usually the easier + one to use. +
	Opacity	+ Set the opacity of the sprite. The value should be between 0 and 1. 1 is solid, 0 is transparent. + Sometimes you want to drag a sprite around the map, or show a sprite that "could be there." Setting + the sprite opacity is usually how you do that. One warning, however. The opacity value takes effect the + next time it is drawn. If the sprite is animating rapidly, it will take effect nearly emmediately. If + it is not animating, not moving, or just sitting there, then it may not take effect for quite some time. +
	PictureBoxLocation	+ The sprite location as found on the picture-box that this sprite is associated with. Used when dealing with mouse-clicks +
	Rotation	+ Change the rotation of the sprite, using degrees. 0 degrees is to the right. 90 is up. + 180 left, 270 down. But, if your sprite was drawn facing up, then rotating it 90 degrees + will have it pointing left. The angle goes counter-clockwise. The image will be scaled + such that it continues to fit within the rectangle that it was originally in. This results + in a little bit of shrinking at times, but you should rarely notice that. +
	SpriteName	+ The name of the sprite. Use SetSpriteName(Name) to change this name. Most Named sprites + are used to define what a sprite is. Once you have created a named sprite, you usually use + DuplicateSprite(String) to clone the sprite for use. The basic rule of thumb is + to load your sprites from images once, and name the initial sprites. Then, when you go to use + those sprites, get duplicates of them. The reason for this is because it takes more processing time to initially + create the sprites than it takes to duplicate them. +
	SpriteOriginName	+ Return the name of the sprite that this was duplicated from. A duplicated sprite will have + no name, but will have a SpriteOriginName. +
	SpriteReachedEndPoint	+ This is true unless we are using MoveTo(point) or MoveTo(list of points) to tell the sprite to move + from one place to the next. This boolean tells us if it has finished or not. +
	VisibleHeight	+ The visible Height as seen in the PictureBox. It may be stretched, or shrunk from the actual + image size. +
	VisibleWidth	+ The visible width as seen in the PictureBox. The Sprite may be stretched or shrunk from the + actual image size. +
	Zvalue	+ A number from 0 to 100. Default = 50. Higher numbers print on top of lower numbers. If you want a sprite to + always be drawn on top of other sprites, give it a number higher than 50. If you want a sprite to go under + other sprites, make its number lower than 50. +

+ +	Name	Description
	CheckBeforeMove	+ This event fires off before a sprite is drawn. Use it if you have constraints. You + can change the location or cancel the move entirely. +
	Click	+ This event happens when someone clicks on the sprite (on the rectangle in which the sprite is). + If you want the event to fire off only when someone clicks on the visible part of the sprite, + use ClickTransparent instead. +
	ClickTransparent	+ This event happens when someone clicks on the sprite (on the sprite image itself). + If the sprite is sometimes hidden, but you want the click to work even if it is not + visible at that instant, use Click instead. +
	MouseEnter	+ When the mouse moves over the sprite. Use this for a menu, when you want the menu item to glow when the + mouse is over the menu item sprite. +
	MouseEnterTransparent	+ When the mouse moves over a non-transparent portoin of the sprite. Use this for a menu, when you want the + menu item to glow when the mouse is over the menu item sprite. +
	MouseHover	+ This event happens when the mouse moves over the sprite, and then pauses. We use the hover timing from the + parent form. +
	MouseHoverTransparent	+ This event happens when the mouse moves over a non-transparent portion of the sprite, and then pauses. + We use the hover timing from the parent form. +
	MouseLeave	+ When the mouse moves off the sprite. Use this for a menu, when you want the menu item to stop glowing when + the mouse moves away from the menu item sprite. +
	MouseLeaveTransparent	+ When the mouse moves off the non-transparent portion of the sprite. Use this for a menu, when you want the + menu item to stop glowing when + the mouse moves away from the menu item sprite. +
	SpriteAnimationComplete	+ Only used when you tell an animation to animate once. At the end of the animation, + this function fires off. +
	SpriteArrivedAtEndPoint	+ An event for when you tell a Sprite to MoveTo(Point) a specific point, or, when you + tell the Sprite to MoveTo(list of points). When the Sprite has reached the final destination, + the Sprite fires off this event. +
	SpriteArrivedAtWaypoint	+ When you tell a sprite to MoveTo(list of points), this fires off every time it gets to + one of the points. When it gets to the final point, only the SpriteAtEndPoint event fires off. +
	SpriteBeingDestroyed	+ The Sprite has just been told to be destroyed. You might want to do some cleanup. + If you need to destroy some payload data, or tell something to cleanup after the sprite + this is where to do that. +
	SpriteChangesAnimationFrames	+ When the frame of an animation changes. If you want to have something happen every time + the foot of your monster comes down, when the swing of your sword is at certain points, etc. + Check to see that the Animaton and FrameIndex are what you expect them to be. +
	SpriteExitsPictureBox	+ This happens when the sprite has exited the picture box. Useful when you want to + keep sprites from traveling on forever after exiting. +
	SpriteHitsPictureBox	+ This happens when the sprite hits the border of the picture-box. + Useful for when you want to have shots explode when they hit the side. +
	SpriteHitsSprite	+ This happens when two sprites hit each-other. The SpriteEventArgs that is returned + contains the sprite that this sprite hits. +
	SpriteInitializes	+ This event happens right after the sprite is created. Use this to immediately set a + sprite to animate once or something like that. +

+ +	Name	Description
	CannotMoveOutsideBox	+ Determine if the sprite will automatically move outside the box. If not, it will hit the side of the box and stick +
	MirrorHorizontally	+ Flip the image when it gets printed. If your sprite is walking left, flipping it will + make it look like it is going right. + This works great for many things. But, if your program is gobbling memory or CPU, you may need to + consider using Sprite.AddAnimation
	MirrorVertically	+ Flip the image when it gets printed. If your sprite looks like it is facing up, doing + this will make it look like it faces down. + This works great for many things. But, if your program is gobbling memory or CPU, you may need to + consider using Sprite.AddAnimation
	MovementSpeed	+ The movement speed of the sprite. To make a Sprite move, you need to set the MovementSpeed, + the direction (using + SetSpriteDirection(Vector), + SetSpriteDirectionToPoint(Point), + SetSpriteDirectionRadians(Double), + or SetSpriteDirectionDegrees(Double)), and the + AutomaticallyMoves property. + The speed is calculated in pixels per amount of time. A higher number is faster than a lower number. +
	payload	+ A Sprite can hold a payload. Use this to store extra information about the various Sprites. Health, Armor, + Shoot time, etc. But, to store information in the payload, you need to make a new class of SpritePayload. The syntax + for doing so is: + Copy public class TankPayload : SpritePayload { public int Armor; public int Speed; } + You can access the payload and retrieve the various values. +

+ +	Class	Description
	Sprite	+ A Sprite is an animated image that has a size, position, rotation, and possible vector + It tracks where in the animation sequence it is, can report colisions, etc. This SpriteController + draws, moves, and deals with most graphical aspects of the sprites for you. +
	SpriteController	+ A sprite controller is the main heart of the sprite class. Each SpriteController manages one picturebox. + If at all possible, try to keep each game in one picturebox, and try to avoid making and destroying + new forms with SpriteController/pictureboxes in them. It is hard to destroy them completely. +
	SpriteEventArgs	+ An EventArgs that contains information about Sprites. Most of the Sprite events use + this SpriteEventArgs. +
	SpritePayload	+ The SpritePayload is a stub of a class, for storing user-defined data and functions along with a sprite. +

+ +	Delegate	Description
	SpriteSpriteEventHandler	+ A delegate that has a SpriteEventArgs instead of EventArgs. Used for most + of the Sprite events. This allows us to pass more information from sprite events than + a basic EventArgs allows for +
	SpriteKeyEventHandler	+ This is a delegate for a keypress event. +

+ +	Enumeration	Description
	SpriteCollisionMethod	+ The various types of collisions a sprite can have. Currently only rectangle works. The other types were added when I + thought the different types of collision types were needed. Someday we may add these if we find they are useful, or if + someone else decides they want to help program the SpriteLibrary. These values are primarily used in Sprite Events +
	SpritePauseType	+ The type of pause signals you can give a sprite or the sprite controller +

+ +	Name	Description
	Cancel	+ Used primarily in the CheckBeforeMove event. If you set cancel to true, then the move fails. + You can use this to keep a Sprite from going places where it ought not to go. +
	CollisionMethod	+ The CollisionMethod used in the event. Currently, only rectangle collisions are used +
	NewLocation	+ For the CheckBeforeMove event, newlocation will be the location the sprite is trying + to move to. You can adjust the point (move it left, right, up, down) and it will affect + the placement of the sprite. +
	TargetSprite	+ If another Sprite is involved in the event (Collision), than that Sprite is included here. + It will be null if no other Sprite is involved. +

+ +	Name	Description
	height_ratio	+ Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. +
	width_ratio	+ Divide a picturebox ratio by this to get the image location. Multiply an image location by this to get the picturebox location. +

+ +	Name	Description
	PutBaseImageLocation(Point)	+ Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + Unless you are using coordinates you have gotten from a mouse-click, this is how you want + to place a Sprite somewhere. It is the easiest way to track things. But, if you are + doing something using mouse-click coordinates, you want to use PutPictureBoxLocation +
	PutBaseImageLocation(Double, Double)	+ Put the Sprite at a specified location, using the dimentions of the BackgroundImage. + Unless you are using coordinates you have gotten from a mouse-click, this is how you want + to place a Sprite somewhere. It is the easiest way to track things. But, if you are + doing something using mouse-click coordinates, you want to use PutPictureBoxLocation +

+ +	Name	Description
	GetImage	+ return the current image frame. Warning: If you write to this image, it will + affect all sprites using this frame. +
	GetImage(Int32, Int32)	+ return the frame for the given index. Warning: If you write to this image, it will + affect all sprites using this frame. +

Member name	Value	Description
rectangle	0	+ Checks if the two rectangles that contain the sprites overlap. Each rectangle is the starting location of the sprite + (top left) with the sprite width, and height marking the other sides of the rectangle. +
circle	1	+ Draws a circle (ellipse) inside the sprite rectangles and see if those ellipses overlap +
transparency	2	+ Check to see if nontransparent portions of a sprite collide. Not working. +

Member name	Value	Description
PauseAnimation	0	+ Pause the animating. Animation resumes from the current frame when we unpause. A paused animation will continue + to display the same image frame until it is unpaused. +
PauseMovement	1	+ Pause any automatic movement. Movement resumes where it was left off if you unpause. The sprite will + just sit there until unpaused. +
PauseEvents	2	+ Pause events. Sprite collisions, movement checks, etc are stopped until the unpause. +
PauseAll	3	+ All pausable things are paused. PauseAnimation, PauseMovement, and PauseEvents. +

Parameters

Reference

Value

Reference

Reference

Parameters

Reference

Parameters

Reference

Parameters

Return Value

Reference

Parameters

Reference

Value

Reference

Parameters

Reference

Property Value

Reference

Property Value

Reference

Reference

Parameters

Reference

Value

Reference

Parameters

Reference

Value

Reference

Field Value

Reference

Parameters

Reference

Parameters

Reference

Reference

Property Value

Reference

Property Value

Reference

Parameters

Reference

Parameters

Return Value

Reference

Parameters

Reference

Reference

Property Value

Reference

Value

Reference

Return Value

Reference

Reference

Reference

Field Value

Reference

Parameters

Reference

Value

Reference

Parameters

Reference

Field Value

Reference

Value

Reference

Parameters

Reference

Parameters

Return Value

Reference

Parameters

Return Value

Reference

Reference

Return Value