#include <opennurbs_pointcloud.h>

Inheritance diagram for ON_PointCloud:

Public Member Functions
	ON_PointCloud ()

	ON_PointCloud (int)

	ON_PointCloud (const ON_PointCloud &)

	~ON_PointCloud ()

void	AppendPoint (const ON_3dPoint &)

void	Destroy ()

void	DestroyHiddenPointArray ()
	Destroys the m_H[] array and sets m_hidden_count=0. More...

int	Dimension () const override
	virtual ON_Geometry override More...

void	Dump (ON_TextLog &) const override
	virtual ON_Object override More...

void	EmergencyDestroy ()
	Call when the memory pool used the point cloud's arrays is no longer in existence. More...

bool	GetBBox (double boxmin, double boxmax, bool bGrowBox=false) const override
	virtual ON_Geometry GetBBox override More...

bool	GetClosestPoint (ON_3dPoint P, int *closest_point_index, double maximum_distance=0.0) const
	Get the index of the point in the point cloud that is closest to P. More...

bool	GetTightBoundingBox (class ON_BoundingBox &tight_bbox, bool bGrowBox=false, const class ON_Xform *xform=nullptr) const override
	virtual ON_Geometry GetTightBoundingBox override More...

bool	HasPlane () const
	for height fields More...

bool	HasPointColors () const

bool	HasPointNormals () const

bool	HasPointValues () const

double	Height (int)

const bool *	HiddenPointArray () const

int	HiddenPointCount () const

unsigned int	HiddenPointUnsignedCount () const

void	InvalidateBoundingBox ()

bool	IsDeformable () const override
	virtual ON_Geometry override More...

bool	IsOrdered () const

bool	IsValid (class ON_TextLog *text_log=nullptr) const override
	Tests an object to see if its data members are correctly initialized. More...

bool	MakeDeformable () override
	virtual ON_Geometry override More...

ON::object_type	ObjectType () const override
	virtual ON_Object override More...

ON_PointCloud &	operator= (const ON_PointCloud &)

ON_3dPoint &	operator[] (int)

const ON_3dPoint &	operator[] (int) const

const ON_Plane &	Plane ()

ON_3dPoint	Point (ON_COMPONENT_INDEX ci) const
	Get a point cloud point from an ON_COMPONENT_INDEX. More...

int	PointCount () const

bool	PointIsHidden (int point_index) const
	Returns true if the point is hidden. This is a runtime setting that is not saved in 3dm files. More...

bool	Read (ON_BinaryArchive &) override
	virtual ON_Object override More...

void	SetHiddenPointFlag (int point_index, bool bHidden)
	Set the runtime hidden point flag. More...

void	SetOrdered (bool bOrdered)
	for ordered streams More...

void	SetPlane (const ON_Plane &)

bool	SwapCoordinates (int, int) override
	virtual ON_Geometry override More...

bool	Transform (const ON_Xform &) override
	virtual ON_Geometry override More...

bool	Write (ON_BinaryArchive &) const override
	virtual ON_Object override More...

Public Member Functions inherited from ON_Geometry
	ON_Geometry ()=default

	ON_Geometry (const ON_Geometry &)=default

	~ON_Geometry ()=default

ON_BoundingBox	BoundingBox () const
	Get object's 3d axis aligned bounding box. More...

virtual class ON_Brep *	BrepForm (class ON_Brep *brep=nullptr) const
	If possible, BrepForm() creates a brep form of the ON_Geometry. More...

virtual void	ClearBoundingBox ()
	Some objects cache bounding box information. If you modify an object, then call ClearBoundingBox() to inform the object that any cached bounding boxes are invalid. More...

virtual ON_COMPONENT_INDEX	ComponentIndex () const
	If this piece of geometry is a component in something larger, like an ON_BrepEdge in an ON_Brep, then this function returns the component index. More...

virtual bool	EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const
	Evaluate the location of a point from the object reference. More...

bool	GetBoundingBox (ON_BoundingBox &bbox, bool bGrowBox=false) const
	Get object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...

bool	GetBoundingBox (ON_3dPoint &bbox_min, ON_3dPoint &bbox_max, bool bGrowBox=false) const
	Get corners of object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...

virtual bool	HasBrepForm () const
	Query an object to see if it has an ON_Brep form. Result: Returns true if the virtual ON_Geometry::BrepForm can compute an ON_Brep representation of this object. More...

ON_Geometry &	operator= (const ON_Geometry &)=default

bool	Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
	Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...

bool	Rotate (double rotation_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
	Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...

bool	Scale (double scale_factor)
	Scales the object by the specified facotor. The scale is centered at the origin. More...

bool	Translate (const ON_3dVector &translation_vector)
	Translates the object along the specified vector. More...

Public Member Functions inherited from ON_Object
	ON_Object () ON_NOEXCEPT

	ON_Object (const ON_Object &)

virtual	~ON_Object ()

virtual ON_AggregateComponentStatus	AggregateComponentStatus () const
	Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...

bool	AttachUserData (class ON_UserData *pUserData)
	Attach user data to an object. More...

unsigned int	ClearAllComponentStates () const
	Set all active level component states to ON_ComponentStatus::NoneSet. More...

virtual unsigned int	ClearComponentStates (ON_ComponentStatus states_to_clear) const
	Clear the specified states on every component. More...

virtual unsigned int	ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const
	Clear states on an individual component. More...

unsigned int	CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)
	Expert user tool that copies user data items with positive values of ON_UserData.m_userdata_copycount from source_object to "this. More...

void	CopyUserData (const ON_Object &source_object)
	Calls CopyUserData(source_object,ON_Object::UserDataConflictResolution::source_object). More...

virtual ON__UINT32	DataCRC (ON__UINT32 current_remainder) const
	Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical. More...

virtual bool	DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
	Delete the portions of the object identified in ci_list[]. More...

virtual void	DestroyRuntimeCache (bool bDelete=true)
	Expert user function. If you are using openNURBS in its default configuration to read and write 3dm archives, you never need to call this function. Many objects employ lazy creation of (runtime) caches that save information to help speed geometric calculations. This function will destroy all runtime information. More...

bool	DetachUserData (class ON_UserData *pUserData)
	Remove user data from an object. More...

void	EmergencyDestroy ()
	Sets m_user_data_list = 0. More...

class ON_UserData *	FirstUserData () const
	User data is stored as a linked list of ON_UserData classes. FirstUserData gets the first item in the linked list. This is the most recent item attached using AttachUserData(). Remark: To iterate through all the user data on an object, call FirstUserData() and then use ON_UserData::Next() to traverse the list. More...

virtual unsigned int	GetComponentsWithSetStates (ON_ComponentStatus states_filter, bool bAllEqualStates, ON_SimpleArray< ON_COMPONENT_INDEX > &components) const

class ON_UserData *	GetUserData (const ON_UUID &userdata_uuid) const
	Get a pointer to user data. More...

bool	GetUserString (const wchar_t *key, ON_wString &string_value) const
	Get user string from the object. More...

int	GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
	Get a list of all user string keys on the object. More...

int	GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
	Get a list of all user strings on the object. More...

bool	IsKindOf (const ON_ClassId *pClassId) const
	Low level tool to test if an object is derived from a specified class. More...

virtual void	MarkAggregateComponentStatusAsNotCurrent () const
	Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...

virtual void	MemoryRelocate ()
	The MemoryRelocate() function is called when an object's location in memory is changed. For example, if an object resides in a chunk of memory that is grown by calling a realloc that has to allocate a new chunk and copy the contents of the old chunk to the new chunk, then the location of the object's memory changes. In practice this happens when classes derived from ON_Object are stored in dynamic arrays, like the default implementation of ON_ObjectArray<>'s that use realloc to grow the dynamic array. More...

virtual ON_UUID	ModelObjectId () const
	All objects in an opennurbs model have an id ( ON_Layer.m_layer_id, ON_Font.m_font_id, ON_Material.m_material_id, ON_3dmObjectAttributes.m_uuid ). More...

unsigned int	MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)
	Expert user tool that moves user data items from source_object to "this. More...

void	MoveUserData (ON_Object &source_object)
	Calls MoveUserData(source_object,ON_Object::UserDataConflictResolution::source_object,true). More...

ON_Object &	operator= (const ON_Object &)

void	PurgeUserData ()
	PurgeUserData() removes all user data from object. More...

virtual unsigned int	SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const
	Set states on an individual component. More...

virtual unsigned int	SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const
	Copy status settings to an individual component. More...

bool	SetUserString (const wchar_t key, const wchar_t string_value)
	Attach a user string to the object. This information will perisist through copy construction, operator=, and file IO. More...

int	SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)
	Append entries to the user string list More...

virtual unsigned int	SizeOf () const

void	TransformUserData (const class ON_Xform &xform)
	Objects derived from ON_Geometry must call TransformUserData() in their Transform() member function. More...

virtual bool	UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)
	Uses the destination_manifest to update references to other components. This is typically done when a component's references came from a "source" context and are being updated to the "destination" context. For example, inserting one model into another when index, id, and name conflicts need to be resolved at the time of insertion. More...

int	UserStringCount () const

Public Attributes
ON_BoundingBox	m_bbox

ON_SimpleArray< ON_Color >	m_C

unsigned int	m_flags = 0

ON_SimpleArray< bool >	m_H

unsigned int	m_hidden_count = 0

ON_SimpleArray< ON_3dVector >	m_N

ON_3dPointArray	m_P
	Implementation. More...

ON_Plane	m_plane

ON_SimpleArray< double >	m_V

Additional Inherited Members
Public Types inherited from ON_Object
enum	UserDataConflictResolution : unsigned char { UserDataConflictResolution::destination_object = 0, UserDataConflictResolution::source_object = 1, UserDataConflictResolution::source_copycount_gt = 2, UserDataConflictResolution::source_copycount_ge = 3, UserDataConflictResolution::destination_copycount_gt = 4, UserDataConflictResolution::destination_copycount_ge = 5, UserDataConflictResolution::delete_item = 6 }
	When a userdata item is copied or moved from a source object to a destination object, the ON_Object::UserDataConflictResolution enum values specify how conficts are resolved. Remark: A userdata item "conflict" occurs when both the destination and source object have a user data item with the same value of ON_UserData::m_userdata_uuid. More...

Static Public Attributes inherited from ON_Geometry
static const ON_Geometry	Unset

Constructor & Destructor Documentation

◆ ON_PointCloud() [1/3]

ON_PointCloud::ON_PointCloud ( )

◆ ON_PointCloud() [2/3]

ON_PointCloud::ON_PointCloud ( int )

◆ ON_PointCloud() [3/3]

ON_PointCloud::ON_PointCloud ( const ON_PointCloud & )

◆ ~ON_PointCloud()

ON_PointCloud::~ON_PointCloud ( )

Member Function Documentation

◆ AppendPoint()

void ON_PointCloud::AppendPoint ( const ON_3dPoint & )

◆ Destroy()

void ON_PointCloud::Destroy ( )

◆ DestroyHiddenPointArray()

void ON_PointCloud::DestroyHiddenPointArray ( )

Destroys the m_H[] array and sets m_hidden_count=0.

◆ Dimension()

int ON_PointCloud::Dimension ( ) const

overridevirtual

virtual ON_Geometry override

Reimplemented from ON_Geometry.

◆ Dump()

void ON_PointCloud::Dump ( ON_TextLog & ) const

overridevirtual

virtual ON_Object override

Reimplemented from ON_Object.

◆ EmergencyDestroy()

void ON_PointCloud::EmergencyDestroy ( )

Call when the memory pool used the point cloud's arrays is no longer in existence.

◆ GetBBox()

bool ON_PointCloud::GetBBox	(	double *	boxmin,
		double *	boxmax,
		bool	bGrowBox = `false`
	)		const

overridevirtual

virtual ON_Geometry GetBBox override

Reimplemented from ON_Geometry.

◆ GetClosestPoint()

bool ON_PointCloud::GetClosestPoint	(	ON_3dPoint	P,
		int *	closest_point_index,
		double	maximum_distance = `0.0`
	)		const

Get the index of the point in the point cloud that is closest to P.

Parameters

P	[in]
closest_point_index	[out]
maximum_distance	[in] optional distance constraint. If maximum_distance > 0, then only points Q with \|P-Q\| <= maximum_distance are tested.

Returns: True if a point is found; in which case *closest_point_index is the index of the point. False if no point is found or the input is not valid.

See also: ON_GetClosestPointInPointList

◆ GetTightBoundingBox()

bool ON_PointCloud::GetTightBoundingBox	(	class ON_BoundingBox &	tight_bbox,
		bool	bGrowBox = `false`,
		const class ON_Xform *	xform = `nullptr`
	)		const

overridevirtual

virtual ON_Geometry GetTightBoundingBox override

Reimplemented from ON_Geometry.

◆ HasPlane()

bool ON_PointCloud::HasPlane ( ) const

for height fields

◆ HasPointColors()

bool ON_PointCloud::HasPointColors ( ) const

Returns: True if m_C.Count() == m_P.Count().

◆ HasPointNormals()

bool ON_PointCloud::HasPointNormals ( ) const

Returns: True if m_N.Count() == m_P.Count().

◆ HasPointValues()

bool ON_PointCloud::HasPointValues ( ) const

Returns: True if m_V.Count() == m_P.Count().

◆ Height()

double ON_PointCloud::Height ( int )

◆ HiddenPointArray()

const bool* ON_PointCloud::HiddenPointArray ( ) const

Returns: If the point cloud has some hidden points, then an array of length PointCount() is returned and the i-th element is true if the i-th vertex is hidden. If no ponts are hidden, nullptr is returned.

◆ HiddenPointCount()

int ON_PointCloud::HiddenPointCount ( ) const

Returns: Number of points that are hidden.

◆ HiddenPointUnsignedCount()

unsigned int ON_PointCloud::HiddenPointUnsignedCount ( ) const

◆ InvalidateBoundingBox()

void ON_PointCloud::InvalidateBoundingBox ( )

◆ IsDeformable()

bool ON_PointCloud::IsDeformable ( ) const

overridevirtual

virtual ON_Geometry override

Reimplemented from ON_Geometry.

◆ IsOrdered()

bool ON_PointCloud::IsOrdered ( ) const

◆ IsValid()

bool ON_PointCloud::IsValid ( class ON_TextLog * text_log = nullptr ) const

overridevirtual

Tests an object to see if its data members are correctly initialized.

Parameters

text_log	[in] if the object is not valid and text_log is not nullptr, then a brief englis description of the reason the object is not valid is appened to the log. The information appended to text_log is suitable for
low	level debugging purposes by programmers and is not intended to be useful as a high level user interface tool.

Returns: table true object is valid false object is invalid, uninitialized, etc.

Reimplemented from ON_Geometry.

◆ MakeDeformable()

bool ON_PointCloud::MakeDeformable ( )

overridevirtual

virtual ON_Geometry override

Reimplemented from ON_Geometry.

◆ ObjectType()

ON::object_type ON_PointCloud::ObjectType ( ) const

overridevirtual

virtual ON_Object override

Reimplemented from ON_Object.

◆ operator=()

ON_PointCloud& ON_PointCloud::operator= ( const ON_PointCloud & )

◆ operator[]() [1/2]

ON_3dPoint& ON_PointCloud::operator[] ( int )

◆ operator[]() [2/2]

const ON_3dPoint& ON_PointCloud::operator[] ( int ) const

◆ Plane()

const ON_Plane& ON_PointCloud::Plane ( )

◆ Point()

ON_3dPoint ON_PointCloud::Point ( ON_COMPONENT_INDEX ci ) const

Get a point cloud point from an ON_COMPONENT_INDEX.

Parameters

ci	[in] a component index with m_typ set to ON_COMPONENT_INDEX::pointcloud_point and 0 <= m_index and m_index < m_P.Count().

Returns: Point at [ci.m_index] or ON_3dPoint::UnsetPoint if ci is not valid.

◆ PointCount()

int ON_PointCloud::PointCount ( ) const

◆ PointIsHidden()

bool ON_PointCloud::PointIsHidden ( int point_index ) const

Returns true if the point is hidden. This is a runtime setting that is not saved in 3dm files.

Parameters

point_index [in]

Returns: True if the point is hidden.

◆ Read()

bool ON_PointCloud::Read ( ON_BinaryArchive & )

overridevirtual

virtual ON_Object override

Reimplemented from ON_Object.

◆ SetHiddenPointFlag()

void ON_PointCloud::SetHiddenPointFlag	(	int	point_index,
		bool	bHidden
	)

Set the runtime hidden point flag.

Parameters

point_index	[in] point vertex index
bHidden	[in] true to hide vertex

◆ SetOrdered()

void ON_PointCloud::SetOrdered ( bool bOrdered )

for ordered streams

◆ SetPlane()

void ON_PointCloud::SetPlane ( const ON_Plane & )

◆ SwapCoordinates()

bool ON_PointCloud::SwapCoordinates	(	int	,
		int
	)

overridevirtual

virtual ON_Geometry override

Reimplemented from ON_Geometry.

◆ Transform()

bool ON_PointCloud::Transform ( const ON_Xform & )

overridevirtual

virtual ON_Geometry override

Reimplemented from ON_Geometry.

◆ Write()

bool ON_PointCloud::Write ( ON_BinaryArchive & ) const

overridevirtual

virtual ON_Object override

Reimplemented from ON_Object.

Member Data Documentation

◆ m_bbox

ON_BoundingBox ON_PointCloud::m_bbox

◆ m_C

ON_SimpleArray<ON_Color> ON_PointCloud::m_C

◆ m_flags

unsigned int ON_PointCloud::m_flags = 0

◆ m_H

ON_SimpleArray<bool> ON_PointCloud::m_H

◆ m_hidden_count

unsigned int ON_PointCloud::m_hidden_count = 0

◆ m_N

ON_SimpleArray<ON_3dVector> ON_PointCloud::m_N

◆ m_P

ON_3dPointArray ON_PointCloud::m_P

Implementation.

◆ m_plane

ON_Plane ON_PointCloud::m_plane

◆ m_V

ON_SimpleArray<double> ON_PointCloud::m_V

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ON_PointCloud() [1/3]

◆ ON_PointCloud() [2/3]

◆ ON_PointCloud() [3/3]

◆ ~ON_PointCloud()

Member Function Documentation

◆ AppendPoint()

◆ Destroy()

◆ DestroyHiddenPointArray()

◆ Dimension()

◆ Dump()

◆ EmergencyDestroy()

◆ GetBBox()

◆ GetClosestPoint()

◆ GetTightBoundingBox()

◆ HasPlane()

◆ HasPointColors()

◆ HasPointNormals()

◆ HasPointValues()

◆ Height()

◆ HiddenPointArray()

◆ HiddenPointCount()

◆ HiddenPointUnsignedCount()

◆ InvalidateBoundingBox()

◆ IsDeformable()

◆ IsOrdered()

◆ IsValid()

◆ MakeDeformable()

◆ ObjectType()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Plane()

◆ Point()

◆ PointCount()

◆ PointIsHidden()

◆ Read()

◆ SetHiddenPointFlag()

◆ SetOrdered()

◆ SetPlane()

◆ SwapCoordinates()

◆ Transform()

◆ Write()

Member Data Documentation

◆ m_bbox

◆ m_C

◆ m_flags

◆ m_H

◆ m_hidden_count

◆ m_N

◆ m_P

◆ m_plane

◆ m_V