Inheritance diagram for SVGArt:

Public Member Functions
	~SVGArt ()

bool	SetRsrc (const PluginID &pid, const RsrcID &rid, const bool isRollOver, const bool isDark=false, const float scaleFactor=1.0, const float iconScale=2.0)

bool	SetRsrc (const RsrcSpec &spec, const float scaleFactor=1.0, const float iconScale=2.0)

bool	SetFile (const IDFile &idFile, const float scaleFactor=1.0, const float iconScale=2.0)

void	Draw (IGraphicsPort *gPort, const PMMatrix &imMatrix, int32 agmflags)

void	DrawDisabled (IGraphicsPort *gPort, const PMMatrix &imMatrix, int32 agmflags)

bool	HasAlpha ()

bool	IsLoaded ()

void	Delete ()

int	GetHeight () const

int	GetWidth () const

AGMImageRecord *	GetBitmap () const

Static Public Member Functions
static void	ReleaseSVGSharedCaches (void)

Constructor & Destructor Documentation

SVGArt::~SVGArt ( )

If a SVG resource has been loaded it deletes it.

Member Function Documentation

void SVGArt::Delete ( )

virtual

Deletes the SVG resource, this is done automatically when this class is destroyed

Implements IArt.

void SVGArt::Draw	(	IGraphicsPort *	gPort,
		const PMMatrix &	imMatrix,
		int32	agmflags
	)

virtual

Draw's the SVG to the supplied graphics port

Parameters

IGraphicsPort,:	IGraphicsPort to draw to
PMMatrix,:	Transformation matrix to apply to the SVG, if no translation is desired use the idenity matrix or just a plain PMMatrix.
agmflags,:	Any desired AGM flags, use 0 if none are desired.

Implements IArt.

void SVGArt::DrawDisabled	(	IGraphicsPort *	gPort,
		const PMMatrix &	imMatrix,
		int32	agmflags
	)

virtual

Draw's the SVG with a 50% transparensy see regular draw methode for more info.

Implements IArt.

AGMImageRecord* SVGArt::GetBitmap ( ) const

virtual

Returns: A pointer to the AGMImageRecord for the loaded SVG resource

Implements IArt.

int SVGArt::GetHeight ( ) const

virtual

Returns: The height of the loaded SVG resource

Implements IArt.

int SVGArt::GetWidth ( ) const

virtual

Returns: The width of the loaded SVG resource

Implements IArt.

bool SVGArt::HasAlpha ( )

virtual

Does the SVG have a alpha?

Returns: true if SVG contains pixels not totally opaque

Implements IArt.

bool SVGArt::IsLoaded ( )

virtual

Did the SVG sucessfully load?

Returns: true if loaded

Implements IArt.

static void SVGArt::ReleaseSVGSharedCaches ( void )

static

Different instantiations of SVGArt may share a cache. ReleaseCaches can be called to free these cache.

bool SVGArt::SetFile	(	const IDFile &	idFile,
		const float	scaleFactor = `1.0`,
		const float	iconScale = `2.0`
	)

virtual

Deletes any currently loaded resource and loads a SVG image file resource in from the supplied file.

Parameters

path	to a SVG file
float	scale factor at which image should be displayed.
float	scale of the icon.

Returns: true if file / resource was loaded

Implements IArt.

bool SVGArt::SetRsrc	(	const PluginID &	pid,
		const RsrcID &	rid,
		const bool	isRollOver,
		const bool	isDark = `false`,
		const float	scaleFactor = `1.0`,
		const float	iconScale = `2.0`
	)

virtual

Deletes any currently loaded resource and loads a SVG image from a plugin's resource. This is the preferred approach.

Parameters

PluginID,:	PluginId to load the resource from
RsrcID,:	Resource ID of the PNG
bool,:	Rollover resource? If false, then a resource type of "SVGA" will be loaded, else a resource type of "SVGR" will be loaded.
bool,:	Dark UI resource? If false, then a resource type of "SVGA" (or "SVGR" if isRollover is true) will be loaded, else a resource type of "SVGD" (or "SVGK" if isRollover is true) will be loaded. Default is false.
float	scale factor at which image should be displayed.
float	scale of the icon.

Returns: true if file / resource was loaded

Implements IArt.

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation