C# Class Nez.ImageMaskTransition

uses an image to mask out part of the scene scaling it from max-to-min then from min-to-max with rotation. Note that the Texture should be loaded in the main Core.contentManager, not a Scene contentManager. The transition will unload it for you. The Texture should be transparent where it should be masked out and white where it should be masked in.
Inheritance: SceneTransition
Show file Open project: prime31/Nez

Public Properties

Property Type Description
delayBeforeMaskOut float
duration float
maxRotation float
maxScale float
minRotation float
minScale float
rotationEaseType EaseType
scaleEaseType EaseType

Public Methods

Method Description
ImageMaskTransition ( Func sceneLoadAction, Microsoft.Xna.Framework.Graphics.Texture2D maskTexture ) : System
ImageMaskTransition ( Microsoft.Xna.Framework.Graphics.Texture2D maskTexture ) : System
onBeginTransition ( ) : IEnumerator
preRender ( Graphics graphics ) : void
render ( Graphics graphics ) : void

Protected Methods

Method Description
transitionComplete ( ) : void

Method Details

ImageMaskTransition() public method

public ImageMaskTransition ( Func sceneLoadAction, Microsoft.Xna.Framework.Graphics.Texture2D maskTexture ) : System
sceneLoadAction Func
maskTexture Microsoft.Xna.Framework.Graphics.Texture2D
return System

ImageMaskTransition() public method

public ImageMaskTransition ( Microsoft.Xna.Framework.Graphics.Texture2D maskTexture ) : System
maskTexture Microsoft.Xna.Framework.Graphics.Texture2D
return System

onBeginTransition() public method

public onBeginTransition ( ) : IEnumerator
return IEnumerator

preRender() public method

public preRender ( Graphics graphics ) : void
graphics Graphics
return void

render() public method

public render ( Graphics graphics ) : void
graphics Graphics
return void

transitionComplete() protected method

protected transitionComplete ( ) : void
return void

Property Details

delayBeforeMaskOut public property

delay after the mask-in before the mark-out begins
public float delayBeforeMaskOut
return float

duration public property

duration of the transition both in and out
public float duration
return float

maxRotation public property

maximum rotation of the mask animation
public float maxRotation
return float

maxScale public property

maximum scale of the mask
public float maxScale
return float

minRotation public property

minimum rotation of the mask animation
public float minRotation
return float

minScale public property

minimum scale of the mask
public float minScale
return float

rotationEaseType public property

ease equation to use for the rotation animation
public EaseType rotationEaseType
return EaseType

scaleEaseType public property

ease equation to use for the scale animation
public EaseType scaleEaseType
return EaseType