git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 05:33:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/classtvg_1_1Accessor.html
Hermet Park 4423fcf58a doc: updated to v0.15
2024-10-04 00:58:19 +09:00

250 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ThorVG: Accessor</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.15</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classtvg_1_1Accessor.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classtvg_1_1Accessor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Accessor<span class="mlabels"><span class="mlabel">final</span></span><div class="ingroups"><a class="el" href="group__ThorVG.html">ThorVG</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> is a utility class to debug the <a class="el" href="classtvg_1_1Scene.html" title="A class to composite children paints.">Scene</a> structure by traversing the scene-tree.
<a href="classtvg_1_1Accessor.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a19696fc28e7eb51f5a4a8603c60e789d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Accessor.html#a19696fc28e7eb51f5a4a8603c60e789d">set</a> (const <a class="el" href="classtvg_1_1Picture.html">Picture</a> *picture, std::function&lt; bool(const <a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint, void *data)&gt; func, void *data) noexcept</td></tr>
<tr class="memdesc:a19696fc28e7eb51f5a4a8603c60e789d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the access function for traversing the <a class="el" href="classtvg_1_1Picture.html" title="A class representing an image read in one of the supported formats: raw, svg, png,...">Picture</a> scene tree nodes. <a href="classtvg_1_1Accessor.html#a19696fc28e7eb51f5a4a8603c60e789d">More...</a><br /></td></tr>
<tr class="separator:a19696fc28e7eb51f5a4a8603c60e789d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4f77dd34469490a192e5b56656f13a50"><td class="memItemLeft" align="right" valign="top">static uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Accessor.html#a4f77dd34469490a192e5b56656f13a50">id</a> (const char *name) noexcept</td></tr>
<tr class="memdesc:a4f77dd34469490a192e5b56656f13a50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a unique ID (hash key) from a given name. <a href="classtvg_1_1Accessor.html#a4f77dd34469490a192e5b56656f13a50">More...</a><br /></td></tr>
<tr class="separator:a4f77dd34469490a192e5b56656f13a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a948e9f4ff06cdc9c19bcc60c1458ecc2"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classtvg_1_1Accessor.html">Accessor</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Accessor.html#a948e9f4ff06cdc9c19bcc60c1458ecc2">gen</a> () noexcept</td></tr>
<tr class="memdesc:a948e9f4ff06cdc9c19bcc60c1458ecc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> object. <a href="classtvg_1_1Accessor.html#a948e9f4ff06cdc9c19bcc60c1458ecc2">More...</a><br /></td></tr>
<tr class="separator:a948e9f4ff06cdc9c19bcc60c1458ecc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> is a utility class to debug the <a class="el" href="classtvg_1_1Scene.html" title="A class to composite children paints.">Scene</a> structure by traversing the scene-tree. </p>
<p>The <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> helps you search specific nodes to read the property information, figure out the structure of the scene tree and its size.</p>
<dl class="section warning"><dt>Warning</dt><dd>We strongly warn you not to change the paints of a scene unless you really know the design-structure.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.10 </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a948e9f4ff06cdc9c19bcc60c1458ecc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a948e9f4ff06cdc9c19bcc60c1458ecc2">&#9670;&nbsp;</a></span>gen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::unique_ptr&lt;<a class="el" href="classtvg_1_1Accessor.html">Accessor</a>&gt; gen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> object. </p>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> object. </dd></dl>
</div>
</div>
<a id="a4f77dd34469490a192e5b56656f13a50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f77dd34469490a192e5b56656f13a50">&#9670;&nbsp;</a></span>id()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint32_t id </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a unique ID (hash key) from a given name. </p>
<p>This function computes a unique identifier value based on the provided string. You can use this to assign a unique ID to the <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a> object.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The input string to generate the unique identifier from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The generated unique identifier value.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classtvg_1_1Paint.html#abaabdc509cdaba7df9f56c6c76f3ae19" title="Unique ID of this instance.">Paint::id</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl>
</div>
</div>
<a id="a19696fc28e7eb51f5a4a8603c60e789d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19696fc28e7eb51f5a4a8603c60e789d">&#9670;&nbsp;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classtvg_1_1Picture.html">Picture</a> *&#160;</td>
<td class="paramname"><em>picture</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::function&lt; bool(const <a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint, void *data)&gt;&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the access function for traversing the <a class="el" href="classtvg_1_1Picture.html" title="A class representing an image read in one of the supported formats: raw, svg, png,...">Picture</a> scene tree nodes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">picture</td><td>The picture node to traverse the internal scene-tree. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>The callback function calling for every paint nodes of the <a class="el" href="classtvg_1_1Picture.html" title="A class representing an image read in one of the supported formats: raw, svg, png,...">Picture</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Data passed to the <code>func</code> as its argument.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The bitmap based picture might not have the scene-tree.</dd>
<dd>
Experimental API </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>tvg</b></li><li class="navelem"><a class="el" href="classtvg_1_1Accessor.html">Accessor</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink