A Sprite, corresponding to a native Window manager icon. More...
#include <ISprite.h>
Public Member Functions | |
| DGNPLATFORM_EXPORT void | GetHotSpot (Point2dP hotspot) |
| Get the X,Y position of the hotspot for this Sprite Definition (0,0 is the upper left corner). More... | |
| DGNPLATFORM_EXPORT void | GetSize (Point2dP size) |
| Get the size (in pixels) of this Sprite Definition. More... | |
| DGNPLATFORM_EXPORT bool | GetUseAlpha () const |
| Get whether to use the alpha channel for this Sprite Definition. More... | |
 Public Member Functions inherited from IRefCounted | |
| virtual UInt32 | AddRef () const =0 |
| virtual UInt32 | Release () const =0 |
Additional Inherited Members | |
| Protected Member Functions inherited from IRefCounted | |
| virtual | ~IRefCounted () |
| void * | operator new (size_t size) |
| void | operator delete (void *rawMemory, size_t size) |
Detailed Description
A Sprite, corresponding to a native Window manager icon.
Generally loaded once at startup via IViewManager::LoadSpriteFromRsrc and saved for the entire session. However, applications can implement this interface on other objects that are able to supply an icon resource.
- Remarks
- Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
Member Function Documentation
| DGNPLATFORM_EXPORT void GetHotSpot | ( | Point2dP | hotspot | ) |
Get the X,Y position of the hotspot for this Sprite Definition (0,0 is the upper left corner).
Often this will be the middle of the Sprite.
- Parameters
-
hotspot OUT the hotspot for this sprite definition
| DGNPLATFORM_EXPORT void GetSize | ( | Point2dP | size | ) |
Get the size (in pixels) of this Sprite Definition.
- Parameters
-
size OUT the size in pixels of this sprite definition.
| DGNPLATFORM_EXPORT bool GetUseAlpha | ( | ) | const |
Get whether to use the alpha channel for this Sprite Definition.
If this is not set then the Icon mask bits are used to determine transparency (which discards the aliasing alpha for Icons which has it set.
The documentation for this struct was generated from the following file: