Difference between revisions of "API Panel.PCloud.Create"
(XML import of Point Cloud API) |
(XML import) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | |||
| − | <sidebar>API | ||
Creates a new point cloud tied to a position handle | Creates a new point cloud tied to a position handle | ||
| Line 16: | Line 14: | ||
:The position to display the cloud at | :The position to display the cloud at | ||
| − | [[Variable Types| | + | [[Variable Types|UINT]] ''DrawMode'' |
:The appearance of the points | :The appearance of the points | ||
:''Typical values for this parameter:'' | :''Typical values for this parameter:'' | ||
| Line 41: | Line 39: | ||
[[Variable Types|HANDLE]] | [[Variable Types|HANDLE]] | ||
| − | + | A handle to the new point cloud | |
==Detailed description== | ==Detailed description== | ||
| − | + | [[File:SIMAPI Panel.PCloud Landscape.png|thumb|150px|Landscape using mandelbrot set]] | |
| + | |||
| + | [[File:SIMAPI Panel.PCloud Torus.png|thumb|150px|Torus rendered with Mode_Line]] | ||
| + | |||
| + | A [http://en.wikipedia.org/wiki/Point_cloud|<nowiki/>point cloud] is a series of points that can represent a graph, shape or terrain in Flowcode. All the parameters passed to this function can be altered using specific calls. | ||
| + | |||
| + | |||
| + | Point clouds can either be rendered using a ''chain'' of points, or a ''grid'' of points. There is no difference when displaying with ''Mode_Point'', but for other modes a chain will render each point as though it is connected to the last, where as a grid assumes a 2-dimensional map, and connects each point to the one above and to the right of it, breaking the sequence at the end of each row of the grid. | ||
| + | |||
| + | [[File:SIMAPI Panel.PCloud PointOrder.svg|thumb|none|400px|Ordering of points in a chain and grid]] | ||
| + | |||
| + | |||
| + | The ''Pos'' is a position handle that the point cloud will scale to. The range of a point cloud in any axis is '''-1 to 1'''. This means that, for example -1 can be considered far left, and 1 as far right. To automatically scale a point cloud to this range, use [[API Panel.PCloud.UnitScale|UnitScale]]. | ||
| + | |||
| + | |||
| + | The ''Pos'' will be tracked by default. This means that the point cloud will take the shape of the position, and if that position changes at any time, the point cloud will change with it. The [[API Panel.PCloud.SetPos|SetPos]] allows this option to be explicitly set. | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Creates a new point cloud tied to a position handle
Contents
Parameters
HANDLE Pos
- The position to display the cloud at
UINT DrawMode
- The appearance of the points
- Typical values for this parameter:
Name Description Mode_Point Displays cloud as points Mode_Line Displays cloud as joined lines Mode_Solid Displays cloud as a solid surface
ULONG RGBA
- The default colour of the points
Return value
A handle to the new point cloud
Detailed description
A point cloud is a series of points that can represent a graph, shape or terrain in Flowcode. All the parameters passed to this function can be altered using specific calls.
Point clouds can either be rendered using a chain of points, or a grid of points. There is no difference when displaying with Mode_Point, but for other modes a chain will render each point as though it is connected to the last, where as a grid assumes a 2-dimensional map, and connects each point to the one above and to the right of it, breaking the sequence at the end of each row of the grid.
The Pos is a position handle that the point cloud will scale to. The range of a point cloud in any axis is -1 to 1. This means that, for example -1 can be considered far left, and 1 as far right. To automatically scale a point cloud to this range, use UnitScale.
The Pos will be tracked by default. This means that the point cloud will take the shape of the position, and if that position changes at any time, the point cloud will change with it. The SetPos allows this option to be explicitly set.
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Panel.PCloud.Create(pos, ::Panel.PCloud.Mode_Point, rgba)
No additional examples
