Accessor

The Accessor is a utility class to debug the Scene structure by traversing the scene-tree. More...

#include <thorvg.h>

Public Member Functions
Result	set (Paint *paint, std::function< bool(const Paint *paint, void *data)> func, void *data) noexcept
	Set the access function for traversing the Picture scene tree nodes.
const char *	name (uint32_t id) noexcept
	Retrieve the original name string from a given unique ID.

Static Public Member Functions
static uint32_t	id (const char *name) noexcept
	Generate a unique ID (hash key) from a given name.
static Accessor *	gen () noexcept
	Creates a new Accessor object.

Detailed Description

The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.

The Accessor helps you search specific nodes to read the property information, figure out the structure of the scene tree and its size.

Warning

We strongly warn you not to change the paints of a scene unless you really know the design-structure.

This class is not designed for inheritance.

Since

0.10

Member Function Documentation

gen()

static Accessor * gen ( )

staticnoexcept

Creates a new Accessor object.

Returns

A new Accessor object.

id()

static uint32_t id ( const char *  name )

staticnoexcept

Generate a unique ID (hash key) from a given name.

This function computes a unique identifier value based on the provided string. You can use this to assign a unique ID to the Paint object.

Parameters

[in]

name

The input string to generate the unique identifier from.

Returns

The generated unique identifier value.

See also

Paint::id

Picture::paint()

Since

1.0

name()

const char * name ( uint32_t  id )

noexcept

Retrieve the original name string from a given unique ID.

Returns the name associated with the specified identifier.

This method is only valid when Picture::accessible is set to true for the Picture associated with the given paint in Accessor::set() Otherwise, the name information may not be available.

Parameters

[in]

id

The unique identifier.

Returns

The corresponding name string, or nullptr if not found or unavailable.

See also

Accessor::id()

Accessor::set()

Picture::accessible

Note

This function is only available within Accessor callbacks registered via Accessor::set().

Since

1.1

set()

Result set ( Paint *  paint, std::function< bool(const Paint *paint, void *data)>  func, void *  data  )

noexcept

Set the access function for traversing the Picture scene tree nodes.

Parameters

[in]	paint	The paint node to traverse the internal scene-tree.
[in]	func	The callback function calling for every paint nodes of the Picture.
[in]	data	Data passed to the func as its argument.

Note

The bitmap based picture might not have the scene-tree.

Since

1.0