CutPoint1D, CutPoint2D, CutPoint3D

Create a 1D, 2D, or 3D cut point dataset.

Syntax

model.result().dataset().create(<dtag>,"CutPoint1D");

model.result().dataset().create(<dtag>,"CutPoint2D");

model.result().dataset().create(<dtag>,"CutPoint3D");

model.result().dataset(<dtag>).set(property, <value>);

Description

model.result().dataset().create(<dtag>,"CutPoint1D") creates a 1D cut point dataset with the name <dtag>.

model.result().dataset().create(<dtag>,"CutPoint2D") creates a 2D cut point dataset with the name <dtag>.

model.result().dataset().create(<dtag>,"CutPoint3D") creates a 3D cut point dataset with the name <dtag>.

A cut point is the 0D analog of cut lines and cut planes. A difference compared to cut lines and cut planes is that a cut point feature can contain an arbitrary number of points. Cut points can exist in 1D, 2D, and 3D.

The following properties are available:

Table 7-24: Valid Property/Value Pairs for Cut Point Datasets
name	Value	Default	Description
bndsnap	Boolean	false	If true, each point is snapped to the closest boundary.
data	none \| dataset name	First compatible dataset	The dataset this feature refers to.
gridx	double array		If method is grid: The grid x-coordinates.
filename	String		If method is file: The file that contains the point coordinates in a spreadsheet format.
gridy	double array		If method is grid: The grid y-coordinates. (Only for CutPoint2D and CutPoint3D.)
gridz	double array		If method is grid: The grid z-coordinates. (Only for CutPoint3D.)
localzphys	array	0	The local z-coordinates, when locdef is set to physical.
localzrel	array of -1–1 numbers	0	The local relative z-coordinates, when locdef is set to relative.
locdef	reference \| physical \| relative	reference	The location definition, in Cut Point 3D datasets where data is set to a Layered Material dataset and snapping is set to boundary or mesh: a reference surface, physical z-coordinate, or a relative z-coordinate.
method	coords \| file \| grid \| regulargrid	coords	The method used for defining the points.
pointvar	String	cpt1n (for the first cut point dataset)	Point number variable for the points defined by the cut point dataset.
pointx	String array	{}	If method is coords: The point x-coordinates.
pointy	String array	{}	If method is coords: The point y-coordinates. (Only for CutPoint2D and CutPoint3D.)
pointz	String array	{}	If method is coords: The point z-coordinates. (Only for CutPoint3D.)
regulargridx	String	10	If method is regulargrid: The number of grid points in the x direction.
regulargridy	String	10	If method is regulargrid: The number of grid points in the y direction. (Only for CutPoint2D and CutPoint3D.)
regulargridz	String	10	If method is regulargrid: The number of grid points in the z direction. (Only for CutPoint3D.)
snapping	none \| boundary \| edge	none	No snapping, snap to closest boundary, or snap to closest edge (for CutPoint3D only).