| SpriteEntity Class |
A sprite entity (3d quad that always faces camera and plays animation from spritesheet texture file).
Inheritance HierarchyNamespace: GeonBit.Core.Graphics
Assembly: GeonBit (in GeonBit.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class SpriteEntity : BaseRenderableEntity
The SpriteEntity type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SpriteEntity(SpriteSheet, MaterialAPI) |
Create the sprite entity.
|
| SpriteEntity(SpriteSheet, Texture2D, Boolean) |
Create the sprite entity from texture and default material.
|
Properties| Name | Description | |
|---|---|---|
 | CameraDistanceBias |
Add bias to distance from camera when sorting by distance from camera.
This is useful for particles, sprites etc.
(Inherited from BaseRenderableEntity.) |
| IsDebugEntity |
If true, this entity will only show in debug / editor mode.
(Inherited from BaseRenderableEntity.) |
| Material |
Get / set sprite material.
|
| Spritesheet |
Get the spritesheet this sprite entity currently uses.
|
| Visible |
Get / Set if this entity is visible.
(Inherited from BaseRenderableEntity.) |
| WireFrame |
If true, will draw just the wireframe of the entity.
Note: settings this property will change the rendering queue property.
(Inherited from BaseRenderableEntity.) |
Methods| Name | Description | |
|---|---|---|
| ChangeSpritesheet |
Change the spritesheet and current step of this sprite.
|
| CopyStep |
Copy spritesheet step from other sprite.
|
| DoEntityDraw |
Draw this model.
(Overrides BaseRenderableEntityDoEntityDraw(Matrix).) |
| Draw |
Draw the entity.
(Inherited from BaseRenderableEntity.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetBoundingBox |
Get the bounding box of this entity, either from cache or calculate it.
(Inherited from BaseRenderableEntity.) |
| GetBoundingSphere |
Get the bounding sphere of this entity, either from cache or calculate it.
(Inherited from BaseRenderableEntity.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLastBoundingBox |
Return the last calculated bounding box.
Note: this value may be out-of-date if transformations changed since last calculation.
(Inherited from BaseRenderableEntity.) |
| GetLastBoundingSphere |
Return the last calculated bounding sphere.
Note: this value may be out-of-date if transformations changed since last calculation.
(Inherited from BaseRenderableEntity.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| PlayAnimation |
Play animation clip.
|
| SetStep(Int32) |
Set spritesheet step from index.
|
| SetStep(String) |
Set spritesheet step from string identifier.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update |
Update animations if currently playing.
|
Fields| Name | Description | |
|---|---|---|
 | BlendingState |
Blending state for this entity.
(Inherited from BaseRenderableEntity.) |
| FaceCamera |
If true, will always face camera. If false will just use node's rotation.
|
| LockedAxis |
Optional axis to constrain rotation to.
|
| MaterialOverride |
Optional custom render settings for this specific sprite instance.
These settings will override some of the material's properties before rendering.
Note: this method is much less efficient than using different materials.
|
| OnAnimationEnd |
Callback to call whenever sprite animation cycle ends (when using animation clips).
|
| RenderingQueue |
Which rendering queue to use for this entity.
Rendering queues determine different rendering settings (like opacity support, blending, sorting etc) + the order
in which the entities are drawn.
(Inherited from BaseRenderableEntity.) |
See Also