NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Public Member Functions
ISpriteElementCollection Class Referenceabstract

Provides access to potential sprite elements. More...

#include <visual_object_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE Count (SDKUInt32 &count) const =0 throw ()
 Returns the number of potential sprites in the VO.
 
virtual SDKResult SDK_CALLTYPE GetSprite (SDKUInt32 index, ISpriteElementSP &sprite)=0 throw ()
 Returns the sprites element specified by index. The first sprite has index 0 and the last sprite has index equal to Count - 1. More...
 

Detailed Description

Provides access to potential sprite elements.

Member Function Documentation

◆ GetSprite()

virtual SDKResult SDK_CALLTYPE GetSprite ( SDKUInt32  index,
ISpriteElementSP &  sprite 
)
throw (
)
pure virtual

Returns the sprites element specified by index. The first sprite has index 0 and the last sprite has index equal to Count - 1.

Parameters
[in]indexIndex of the sprites in the sprites collection.
[out]spriteSmart pointer to the ISpriteElement interface.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_InvalidArgument - Indicates a wrong index.
The documentation for this class was generated from the following file: