eDriven Framework API
CursorManager Class
Namespaces ► eDriven.Gui.Cursor ► CursorManager
eDriven Framework API
Cursor manager manages cursors By default, only the system cursor (arrow) is visible in Unity This class adds other cursor images / animations The animations are being loaded from the animation package In fact, a whole package is loaded at once and set to CursorAnimator Then, CursorAnimator is responsible for animating the selected animation from current package
Declaration Syntax

C# | Visual Basic | Visual C++

    public sealed class CursorManager

    Public NotInheritable Class CursorManager

    public ref class CursorManager sealed

Members

All Members | Constructors | Methods | Properties | Fields
Public Protected | Instance Static | Declared Inherited

Icon | Member | Description
--- | --- | ---
| CursorManager()()()() | Initializes a new instance of the CursorManager class
| DebugMode | Debug mode
| DefaultCursorPackagePath | Default cursor package path inside the "Resources" folder
| Enabled | If true, cursor manager is enabled You can turn of cursor management here (for mobile etc.)
| Equals(Object) | 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 a hash function for a particular type. (Inherited from Object.)
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.)
| Instance | Singleton instance
| LoadPackage(String) | Loads the animation package (specified by the XML file and additional graphics)
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.)
| Preload()()()() | If you want cursor animation to be loaded on app start, call this method
| RemoveAllCursors()()()() | Removes all cursors from the stack and shows the system cursor
| RemoveCursor(Int32) | Removes the cursor specified by cursor ID from the stack
| RenderingMode | Cursor rendering mode The cursor could be rendered in one of the three modes (2 Unity modes and 1 eDriven mode)
| Report()()()() |
| SetCursor(String, Int32) | Inserts the cursor on th estack This doesn't mean that the supplied cursor will be shown It all depends of the stack content If there are cursors with the higher priority, the cursor with the highest priority will be shown The inserted cursor will be shown when all other cursors with higher or equal priority will be removed
| SetCursor(String) | Inserts the cursor on th estack This doesn't mean that the supplied cursor will be shown It all depends of the stack content If there are cursors with the higher priority, the cursor with the highest priority will be shown The inserted cursor will be shown when all other cursors with higher or equal priority will be removed
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.)

Inheritance Hierarchy

Object
| CursorManager

Assembly: eDriven.Gui (Module: eDriven.Gui) Version: 2.0.1.0 (2.0.1.0)