lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-05-05 06:56:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Publish!

Browse Source 
Generated from v6.0.11315.11111-test10
This commit is contained in:
Bozo
2018-01-26 04:54:48 -08:00
parent 2ea16cc86c
commit 55446d56ce
1111 changed files with 7129 additions and 10641 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
6/d7/de3/class_o_n___texture_mapping.html
View File

@@ -3,7 +3,7 @@
<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.8.14"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_TextureMapping Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -22,6 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openNURBS SDK Help
&#160;<span id="projectnumber">6.0</span>
</div>
</td>
</tr>
@@ -29,21 +30,18 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<!-- Generated by Doxygen 1.8.13 -->
<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');
/* @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>
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -152,8 +150,8 @@ Public Types</h2></td></tr>
<a class="el" href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eacaf53acc9e6d0618a0e0d4db806de77642">Type::HistoryRecord</a> = 13,
<a class="el" href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eaca699b4f79215d191584653efebf156e52">Type::Mixed</a> = 0xFE
<br />
}</td></tr>
<tr class="memdesc:a2977d69091b4952cc19b0189a28a0eac"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eac" title="The ON_ModelComponent::Type enum has a value for each explicit component type and two special values...">ON_ModelComponent::Type</a> enum has a value for each explicit component type and two special values, Unset and Mixed. Use an <a class="el" href="../../d0/d89/class_o_n___model_component_type_iterator.html">ON_ModelComponentTypeIterator</a> instance to iterate over the <a class="el" href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eac" title="The ON_ModelComponent::Type enum has a value for each explicit component type and two special values...">ON_ModelComponent::Type</a> values. /summary&gt; <a href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eac">More...</a><br /></td></tr>
}<tr class="memdesc:a2977d69091b4952cc19b0189a28a0eac"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eac" title="The ON_ModelComponent::Type enum has a value for each explicit component type and two special values...">ON_ModelComponent::Type</a> enum has a value for each explicit component type and two special values, Unset and Mixed. Use an <a class="el" href="../../d0/d89/class_o_n___model_component_type_iterator.html">ON_ModelComponentTypeIterator</a> instance to iterate over the <a class="el" href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eac" title="The ON_ModelComponent::Type enum has a value for each explicit component type and two special values...">ON_ModelComponent::Type</a> values. /summary&gt; <a href="../../dc/d5c/class_o_n___model_component.html#a2977d69091b4952cc19b0189a28a0eac">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a2977d69091b4952cc19b0189a28a0eac inherit pub_types_class_o_n___model_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_class_o_n___object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_o_n___object')"><img src="../../closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="../../d9/d7b/class_o_n___object.html">ON_Object</a></td></tr>
<tr class="memitem:a7f520e987ffa14e71b06493340f9956c inherit pub_types_class_o_n___object"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d7b/class_o_n___object.html#a7f520e987ffa14e71b06493340f9956c">UserDataConflictResolution</a> : unsigned char { <br />
@@ -958,8 +956,8 @@ Additional Inherited Members</h2></td></tr>
<p>Description: Evaluate the mapping to get a texture coordinate. Parameters: P - [in] Vertex location N - [in] If the mapping projection is ray_projection, then this is the vertex unit normal. Otherwise N is ignored. T - [out] Texture coordinate (u,v,w)</p>
<p>P_xform -[in] Transformation to be applied to P before performing the mapping calculation. N_xform - [in] Transformation to be applied to N before performing the mapping calculation. One way to calculate N_xform is to use the call P_xform::GetVectorTransform(N_xform).</p>
<p>Returns: Nonzero if evaluation is successful. When the mapping is a box or capped cylinder mapping, the value indicates which side was evaluated.</p>
<p>Cylinder mapping: 1 = cylinder wall, 2 = bottom cap, 3 = top cap Box mapping: 1 = front 2 = right 3 = back 4 = left 5 = bottom 6 = top <br />
See Also: <a class="el" href="../../d7/de3/class_o_n___texture_mapping.html#a8465fda24c41092aec22bbf01172e4a0">ON_TextureMapping::GetTextureCoordinates</a> <a class="el" href="../../df/d11/class_o_n___mesh.html#ac63b1a95fe549071b2500ba9ea2c8319">ON_Mesh::SetTextureCoordinates</a> </p>
<p>Cylinder mapping: 1 = cylinder wall, 2 = bottom cap, 3 = top cap Box mapping: 1 = front 2 = right 3 = back 4 = left 5 = bottom 6 = top</p>
<p>See Also: <a class="el" href="../../d7/de3/class_o_n___texture_mapping.html#a8465fda24c41092aec22bbf01172e4a0">ON_TextureMapping::GetTextureCoordinates</a> <a class="el" href="../../df/d11/class_o_n___mesh.html#ac63b1a95fe549071b2500ba9ea2c8319">ON_Mesh::SetTextureCoordinates</a> </p>
</div>
</div>
@@ -1227,8 +1225,7 @@ Additional Inherited Members</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Get a box projection from the texture mapping. Parameters: plane - [out] <br />
The center of the box is at plane.origin and the sides of the box are parallel to the plane's coordinate planes. dx - [out] The "front" and "back" sides of the box are in spanned by the vectors plane.yaxis and plane.zaxis. The back plane contains the point plane.PointAt(dx[0],0,0) and the front plane contains the point plane.PointAt(dx[1],0,0). dy - [out] The "left" and "right" sides of the box are in spanned by the vectors plane.zaxis and plane.xaxis. The left plane contains the point plane.PointAt(0,dx[0],0) and the back plane contains the point plane.PointAt(0,dy[1],0). dz - [out] The "top" and "bottom" sides of the box are in spanned by the vectors plane.xaxis and plane.yaxis. The bottom plane contains the point plane.PointAt(0,0,dz[0]) and the top plane contains the point plane.PointAt(0,0,dz[1]). Returns: True if a valid box is returned. Remarks: Generally, GetMappingBox will not return the same parameters passed to SetBoxMapping. However, the location of the box will be the same. </p>
<p>Get a box projection from the texture mapping. Parameters: plane - [out] The center of the box is at plane.origin and the sides of the box are parallel to the plane's coordinate planes. dx - [out] The "front" and "back" sides of the box are in spanned by the vectors plane.yaxis and plane.zaxis. The back plane contains the point plane.PointAt(dx[0],0,0) and the front plane contains the point plane.PointAt(dx[1],0,0). dy - [out] The "left" and "right" sides of the box are in spanned by the vectors plane.zaxis and plane.xaxis. The left plane contains the point plane.PointAt(0,dx[0],0) and the back plane contains the point plane.PointAt(0,dy[1],0). dz - [out] The "top" and "bottom" sides of the box are in spanned by the vectors plane.xaxis and plane.yaxis. The bottom plane contains the point plane.PointAt(0,0,dz[0]) and the top plane contains the point plane.PointAt(0,0,dz[1]). Returns: True if a valid box is returned. Remarks: Generally, GetMappingBox will not return the same parameters passed to SetBoxMapping. However, the location of the box will be the same. </p>
</div>
</div>
@@ -1247,9 +1244,7 @@ Additional Inherited Members</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Get a cylindrical projection parameters from this texture mapping. Parameters: cylinder - [out] <br />
Returns: True if a valid cylinder is returned. Remarks: Generally, GetMappingCylinder will not return the same parameters passed to SetCylinderMapping. However, the location of the cylinder will be the same. <br />
If this mapping is not cylindrical, the cylinder will approximate the actual mapping primitive. </p>
<p>Description: Get a cylindrical projection parameters from this texture mapping. Parameters: cylinder - [out] Returns: True if a valid cylinder is returned. Remarks: Generally, GetMappingCylinder will not return the same parameters passed to SetCylinderMapping. However, the location of the cylinder will be the same. If this mapping is not cylindrical, the cylinder will approximate the actual mapping primitive. </p>
</div>
</div>
@@ -1309,8 +1304,7 @@ Returns: True if a valid cylinder is returned. Remarks: Generally, GetMappingCyl
</tr>
</table>
</div><div class="memdoc">
<p>Description: Get a spherical projection parameters from this texture mapping. Parameters: sphere - [out] <br />
Returns: True if a valid sphere is returned. Remarks: Generally, GetMappingShere will not return the same parameters passed to SetSphereMapping. However, the location of the sphere will be the same. If this mapping is not cylindrical, the cylinder will approximate the actual mapping primitive. </p>
<p>Description: Get a spherical projection parameters from this texture mapping. Parameters: sphere - [out] Returns: True if a valid sphere is returned. Remarks: Generally, GetMappingShere will not return the same parameters passed to SetSphereMapping. However, the location of the sphere will be the same. If this mapping is not cylindrical, the cylinder will approximate the actual mapping primitive. </p>
</div>
</div>
@@ -1357,8 +1351,7 @@ Returns: True if a valid sphere is returned. Remarks: Generally, GetMappingShere
</tr>
</table>
</div><div class="memdoc">
<p>Description: Get texture coordinates. This calculation is expensive. When possible, use a MappingMatch() query to avoid unnecessary calculations. Parameters: mesh - [in] T - [out] Texture coordinates returned here. mesh_xform - [in] (optional) If the mesh has been transformed since the texture mapping was set up, pass the transformation here. Typically this is the value of ON_Mesh::m_mapping_xform or ON_MappingRef::m_object_xform bLazy - [in] If true and the mesh.m_T[] values were calculated using this mapping, they are simply copied to the T[] array and no calculations are performed. If you are calling the 3d point version and you care about the z-coordinate, then do not use the lazy option (meshes only store 2d texture coordinates). Tside - [out] In the case of divided textures, side information is returned here if a lazy mapping is not done. Otherwise Tside-&gt;Count() will be zero. Cylinder mapping: 1 = cylinder wall, 2 = bottom cap, 3 = top cap Box mapping: 1 = front 2 = right 3 = back 4 = left 5 = bottom 6 = top <br />
Example: </p><pre class="fragment"> ON_TextureMapping mapping = ...;
<p>Description: Get texture coordinates. This calculation is expensive. When possible, use a MappingMatch() query to avoid unnecessary calculations. Parameters: mesh - [in] T - [out] Texture coordinates returned here. mesh_xform - [in] (optional) If the mesh has been transformed since the texture mapping was set up, pass the transformation here. Typically this is the value of ON_Mesh::m_mapping_xform or ON_MappingRef::m_object_xform bLazy - [in] If true and the mesh.m_T[] values were calculated using this mapping, they are simply copied to the T[] array and no calculations are performed. If you are calling the 3d point version and you care about the z-coordinate, then do not use the lazy option (meshes only store 2d texture coordinates). Tside - [out] In the case of divided textures, side information is returned here if a lazy mapping is not done. Otherwise Tside-&gt;Count() will be zero. Cylinder mapping: 1 = cylinder wall, 2 = bottom cap, 3 = top cap Box mapping: 1 = front 2 = right 3 = back 4 = left 5 = bottom 6 = top Example: </p><pre class="fragment"> ON_TextureMapping mapping = ...;
const ON_Mesh* mesh = ...;
bool bLazy = true;
ON_SimpleArray&lt;ON_3dPoint&gt; T(mesh-&gt;VertexCount());
@@ -1716,9 +1709,7 @@ Example: </p><pre class="fragment"> ON_TextureMapping mapping = ...;
</tr>
</table>
</div><div class="memdoc">
<p>Description: Create a box projection texture mapping. Parameters: plane - [in] <br />
The sides of the box the box are parallel to the plane's coordinate planes. The dx, dy, dz intervals determine the location of the sides. dx - [in] Determines the location of the front and back planes. The vector plane.xaxis is perpendicular to these planes and they pass through plane.PointAt(dx[0],0,0) and plane.PointAt(dx[1],0,0), respectivly. dy - [in] Determines the location of the left and right planes. The vector plane.yaxis is perpendicular to these planes and they pass through plane.PointAt(0,dy[0],0) and plane.PointAt(0,dy[1],0), respectivly. dz - [in] Determines the location of the top and bottom planes. The vector plane.zaxis is perpendicular to these planes and they pass through plane.PointAt(0,0,dz[0]) and plane.PointAt(0,0,dz[1]), respectivly. bIsCapped - [in] If true, the box is treated as a finite capped box. <br />
Returns: True if input is valid. Remarks: When m_texture_space = divided, the box is mapped to texture space as follows:</p>
<p>Description: Create a box projection texture mapping. Parameters: plane - [in] The sides of the box the box are parallel to the plane's coordinate planes. The dx, dy, dz intervals determine the location of the sides. dx - [in] Determines the location of the front and back planes. The vector plane.xaxis is perpendicular to these planes and they pass through plane.PointAt(dx[0],0,0) and plane.PointAt(dx[1],0,0), respectivly. dy - [in] Determines the location of the left and right planes. The vector plane.yaxis is perpendicular to these planes and they pass through plane.PointAt(0,dy[0],0) and plane.PointAt(0,dy[1],0), respectivly. dz - [in] Determines the location of the top and bottom planes. The vector plane.zaxis is perpendicular to these planes and they pass through plane.PointAt(0,0,dz[0]) and plane.PointAt(0,0,dz[1]), respectivly. bIsCapped - [in] If true, the box is treated as a finite capped box. Returns: True if input is valid. Remarks: When m_texture_space = divided, the box is mapped to texture space as follows:</p>
<p>If the box is not capped, then each side maps to 1/4 of the texture map. </p><pre class="fragment"> v=1+---------+---------+---------+---------+
| x=dx[1] | y=dy[1] | x=dx[0] | y=dy[0] |
| Front | Right | Back | Left |
@@ -1776,9 +1767,7 @@ Returns: True if input is valid. Remarks: When m_texture_space = divided, the bo
</tr>
</table>
</div><div class="memdoc">
<p>Description: Create a cylindrical projection texture mapping. Parameters: cylinder - [in] <br />
cylinder in world space used to define a cylindrical coordinate system. The angular parameter maps (0,2pi) to texture "u" (0,1), The height parameter maps (height[0],height[1]) to texture "v" (0,1), and the radial parameter maps (0,r) to texture "w" (0,1). bIsCapped - [in] If true, the cylinder is treated as a finite capped cylinder. <br />
Returns: True if input is valid. Remarks: When the cylinder is capped and m_texture_space = divided, the cylinder is mapped to texture space as follows: The side is mapped to 0 &lt;= "u" &lt;= 2/3. The bottom is mapped to 2/3 &lt;= "u" &lt;= 5/6. The top is mapped to 5/6 &lt;= "u" &lt;= 5/6. This is the same convention box mapping uses. </p>
<p>Description: Create a cylindrical projection texture mapping. Parameters: cylinder - [in] cylinder in world space used to define a cylindrical coordinate system. The angular parameter maps (0,2pi) to texture "u" (0,1), The height parameter maps (height[0],height[1]) to texture "v" (0,1), and the radial parameter maps (0,r) to texture "w" (0,1). bIsCapped - [in] If true, the cylinder is treated as a finite capped cylinder. Returns: True if input is valid. Remarks: When the cylinder is capped and m_texture_space = divided, the cylinder is mapped to texture space as follows: The side is mapped to 0 &lt;= "u" &lt;= 2/3. The bottom is mapped to 2/3 &lt;= "u" &lt;= 5/6. The top is mapped to 5/6 &lt;= "u" &lt;= 5/6. This is the same convention box mapping uses. </p>
</div>
</div>
@@ -1819,10 +1808,7 @@ Returns: True if input is valid. Remarks: When the cylinder is capped and m_text
</tr>
</table>
</div><div class="memdoc">
<p>Description: Create a planar projection texture mapping. Parameters: plane - [in] dx - [in] portion of the plane's x axis that is mapped to [0,1] (can be a decreasing interval) <br />
dy - [in] portion of the plane's x axis that is mapped to [0,1] (can be a decreasing interval) <br />
dz - [in] portion of the plane's x axis that is mapped to [0,1] (can be a decreasing interval) <br />
projection_method - [in] 1: Closest point mapping. A target point P is mapped to the point on the plane that is closest to P. The target normal is ignored. 2: Target line mapping. A target point-vector pair (P, N), are mapped to the point on the plane where the line through P, parallel to N, intersects the plane. If the line is parallel to the plane, the closest point mapping is used. Example: Create a mapping that maps the world axis aligned rectangle in the world yz plane with corners at (0,3,5) and (0,7,19) to the texture coordinate unit square. </p><pre class="fragment"> ON_3dVector plane_xaxis(0.0,1.0,0.0);
<p>Description: Create a planar projection texture mapping. Parameters: plane - [in] dx - [in] portion of the plane's x axis that is mapped to [0,1] (can be a decreasing interval) dy - [in] portion of the plane's x axis that is mapped to [0,1] (can be a decreasing interval) dz - [in] portion of the plane's x axis that is mapped to [0,1] (can be a decreasing interval) projection_method - [in] 1: Closest point mapping. A target point P is mapped to the point on the plane that is closest to P. The target normal is ignored. 2: Target line mapping. A target point-vector pair (P, N), are mapped to the point on the plane where the line through P, parallel to N, intersects the plane. If the line is parallel to the plane, the closest point mapping is used. Example: Create a mapping that maps the world axis aligned rectangle in the world yz plane with corners at (0,3,5) and (0,7,19) to the texture coordinate unit square. </p><pre class="fragment"> ON_3dVector plane_xaxis(0.0,1.0,0.0);
ON_3dVector plane_yaxis(0.0,0,0,1.0);
ON_3dPoint plane_origin(0.0,2.0,4.0);
ON_Plane plane(plane_origin,plane_xaxis,plane_yaxis);
@@ -1850,8 +1836,7 @@ Returns: True if input is valid. Remarks: When the cylinder is capped and m_text
</tr>
</table>
</div><div class="memdoc">
<p>Description: Create a spherical projection texture mapping. Parameters: sphere - [in] <br />
sphere in world space used to define a spherical coordinate system. The longitude parameter maps (0,2pi) to texture "u" (0,1). The latitude paramter maps (-pi/2,+pi/2) to texture "v" (0,1). The radial parameter maps (0,r) to texture "w" (0,1). Returns: True if input is valid. </p>
<p>Description: Create a spherical projection texture mapping. Parameters: sphere - [in] sphere in world space used to define a spherical coordinate system. The longitude parameter maps (0,2pi) to texture "u" (0,1). The latitude paramter maps (-pi/2,+pi/2) to texture "v" (0,1). The radial parameter maps (0,r) to texture "w" (0,1). Returns: True if input is valid. </p>
</div>
</div>
@@ -2093,8 +2078,8 @@ Returns: True if input is valid. Remarks: When the cylinder is capped and m_text
</tr>
</table>
</div><div class="memdoc">
<p>Description: Low level archive writing tool used by <a class="el" href="../../db/d16/class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b" title="writes object definition ">ON_BinaryArchive::WriteObject()</a>. Parameters: binary_archive - archive to write to Returns: Returns true if the write is successful. Remarks: Use <a class="el" href="../../db/d16/class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b" title="writes object definition ">ON_BinaryArchive::WriteObject()</a> to write objects. This <a class="el" href="../../d7/de3/class_o_n___texture_mapping.html#abf7c5fb8a77432d72dd4b02148e076c8">Write()</a> function should just write the specific definition of this object. It should not write and any chunk typecode or length information. <br />
The default implementation of this virtual function returns false and does nothing. </p>
<p>Description: Low level archive writing tool used by <a class="el" href="../../db/d16/class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b" title="writes object definition ">ON_BinaryArchive::WriteObject()</a>. Parameters: binary_archive - archive to write to Returns: Returns true if the write is successful. Remarks: Use <a class="el" href="../../db/d16/class_o_n___binary_archive.html#a33187abe5d04ac52c41d7a798e664f3b" title="writes object definition ">ON_BinaryArchive::WriteObject()</a> to write objects. This <a class="el" href="../../d7/de3/class_o_n___texture_mapping.html#abf7c5fb8a77432d72dd4b02148e076c8">Write()</a> function should just write the specific definition of this object. It should not write and any chunk typecode or length information.</p>
<p>The default implementation of this virtual function returns false and does nothing. </p>
<p>Reimplemented from <a class="el" href="../../d9/d7b/class_o_n___object.html#a16eb9ab6bf0d0a614655cf9cd055871a">ON_Object</a>.</p>
@@ -2252,9 +2237,9 @@ Returns: True if input is valid. Remarks: When the cylinder is capped and m_text
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 26 2018 12:38:23 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Fri Jan 26 2018 04:54:33 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.14
</a> 1.8.13
</small></address>
</body>
</html>