Sprite element. More...

#include <visual_object_interface.h>

Inherits ISDKComponent.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	GetUniqueId (SDKUInt16 &id, SDKAny &var_key) const =0 throw ()
	Returns the unique key composed of two parts: a two-byte SDL script ID and variable length byte stream. More...

virtual SDKResult SDK_CALLTYPE	CreateTexture (const sdk::gfx::RenderTargetSP &target, SDKPointI2D &org, SDKRect2D &rect) const =0 throw ()
	Draws symbol to the specified texture render target. More...

virtual SDKResult SDK_CALLTYPE	GetPosition (const sdk::gfx::RenderTargetSP &target, const sdk::geometry::GeometryPathSP &geometry, const IDrawingContextSP &context, SDKAny &positions) const =0 throw ()
	Returns array of positions and angles for this sprite. More...

virtual SDKResult SDK_CALLTYPE	GetVisualObject (IVisualObjectSP &vo)=0 throw ()
	Returns the correspondent visual object. More...

virtual SDKResult SDK_CALLTYPE	SetFlags (const SDKUInt16 flags)=0 throw ()
	Setter and getter for visual object flags.

virtual SDKResult SDK_CALLTYPE	ClearVectorData (void)=0 throw ()
	Clears all cached vector data of the visual object (if any). More...

Detailed Description

Sprite element.

Member Function Documentation

◆ GetUniqueId()

virtual SDKResult SDK_CALLTYPE GetUniqueId	(	SDKUInt16 &	id,
		SDKAny &	var_key
	)		const
throw	(
	)

pure virtual

Returns the unique key composed of two parts: a two-byte SDL script ID and variable length byte stream.

Parameters

[out]	id	SDL script ID.
[out]	var_key	variable length key.

Returns: kSDKResult_Succeeded; kSDKResult_NotImplemented

◆ CreateTexture()

virtual SDKResult SDK_CALLTYPE CreateTexture	(	const sdk::gfx::RenderTargetSP &	target,
		SDKPointI2D &	org,
		SDKRect2D &	rect
	)		const
throw	(
	)

pure virtual

Draws symbol to the specified texture render target.

Parameters

[in]	target	Texture render target interface.
[out]	org	Origin (pivot point).
[out]	rect	Texture actual dimensions.

Returns: kSDKResult_Succeeded; kSDKResult_NotImplemented

◆ GetPosition()

virtual SDKResult SDK_CALLTYPE GetPosition	(	const sdk::gfx::RenderTargetSP &	target,
		const sdk::geometry::GeometryPathSP &	geometry,
		const IDrawingContextSP &	context,
		SDKAny &	positions
	)		const
throw	(
	)

pure virtual

Returns array of positions and angles for this sprite.

Parameters

[in]	target	Render target interface.
[in]	geometry	Geometry.
[out]	positions	Safe array of SDKPosition structures.

Returns: kSDKResult_Succeeded if there are any positions; kSDKResult_False if there are not any positions; kSDKResult_NotImplemented

◆ GetVisualObject()

virtual SDKResult SDK_CALLTYPE GetVisualObject	(	IVisualObjectSP &	vo	)
throw	(
	)

pure virtual

Returns the correspondent visual object.

Parameters

[out] vo Smart pointer to the IVisualObject interface.

Returns: kSDKResult_Succeeded; kSDKResult_NotImplemented

◆ ClearVectorData()

virtual SDKResult SDK_CALLTYPE ClearVectorData	(	void	)
throw	(
	)

pure virtual

Clears all cached vector data of the visual object (if any).

Returns: kSDKResult_Succeeded

The documentation for this class was generated from the following file:

visual_object_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetUniqueId()

◆ CreateTexture()

◆ GetPosition()

◆ GetVisualObject()

◆ ClearVectorData()