#include <opennurbs_mesh.h>

Inheritance diagram for ON_MeshComponentRef:

Public Member Functions
	ON_MeshComponentRef ()

	ON_MeshComponentRef (const class ON_Mesh *mesh, ON_COMPONENT_INDEX ci)

	~ON_MeshComponentRef ()

ON_COMPONENT_INDEX	ComponentIndex () const override
	Override of the virtual ON_Geometry::ComponentIndex(). More...

int	Dimension () const override
	overrides of virtual ON_Geometry functions More...

void	Dump (ON_TextLog &) const override
	Creates a text dump of the object. More...

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

unsigned int	GetMeshFace (const class ON_MeshFace *&mesh_face) const

unsigned int	GetMeshTopologyEdge (const struct ON_MeshTopologyEdge *&tope) const

unsigned int	GetMeshTopologyEdgeAndLine (const struct ON_MeshTopologyEdge *&tope, ON_Line &line) const

unsigned int	GetMeshTopologyEdgeLine (class ON_Line &line) const

unsigned int	GetMeshTopologyVertex (const struct ON_MeshTopologyVertex *&topv) const

unsigned int	GetMeshTopologyVertexAndPoint (const struct ON_MeshTopologyVertex *&topv, class ON_3dPoint &point) const

unsigned int	GetMeshTopologyVertexPoint (class ON_3dPoint &point) const

unsigned int	GetVertexPoint (class ON_3dPoint &point) const

bool	IsValid (class ON_TextLog *text_log=nullptr) const override
	overrides of virtual ON_Object functions More...

const class ON_Mesh *	Mesh () const

const class ON_MeshFace *	MeshFace () const

unsigned int	MeshFaceIndex () const

const class ON_MeshNgon *	MeshNgon (class ON_MeshNgonBuffer &ngon_buffer) const

const class ON_MeshNgon *	MeshNgon () const

unsigned int	MeshNgonIndex () const

const class ON_MeshTopology *	MeshTopology () const

const struct ON_MeshTopologyEdge *	MeshTopologyEdge () const

unsigned int	MeshTopologyEdgeIndex () const

const struct ON_MeshTopologyVertex *	MeshTopologyVertex () const

unsigned int	MeshTopologyVertexIndex () const

ON::object_type	ObjectType () const override
	Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. More...

ON_MeshComponentRef &	operator= (const ON_MeshComponentRef &)

void	Set (const class ON_Mesh *mesh, ON_COMPONENT_INDEX ci)

unsigned int	SizeOf () const override

bool	Transform (const ON_Xform &xform) override
	Transforms the object. More...

unsigned int	VertexIndex () const

ON_3dPoint	VertexPoint () const

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 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	GetTightBoundingBox (class ON_BoundingBox &tight_bbox, bool bGrowBox=false, const class ON_Xform *xform=nullptr) const
	Get tight 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...

virtual bool	IsDeformable () const

virtual bool	MakeDeformable ()
	If possible, converts the object into a form that can be accuratly modified with "squishy" transformations like projections, shears, an non-uniform scaling. 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...

virtual bool	SwapCoordinates (int i, int j)
	Swaps object coordinate values with indices i and j. 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 bool	Read (ON_BinaryArchive &binary_archive)
	Low level archive writing tool used by ON_BinaryArchive::ReadObject(). 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...

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

virtual bool	Write (ON_BinaryArchive &binary_archive) const
	Low level archive writing tool used by ON_BinaryArchive::WriteObject(). More...

Static Public Attributes
static const ON_MeshComponentRef	Unset

Static Public Attributes inherited from ON_Geometry
static const ON_Geometry	Unset

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...

Constructor & Destructor Documentation

◆ ON_MeshComponentRef() [1/2]

ON_MeshComponentRef::ON_MeshComponentRef ( )

◆ ON_MeshComponentRef() [2/2]

ON_MeshComponentRef::ON_MeshComponentRef	(	const class ON_Mesh *	mesh,
		ON_COMPONENT_INDEX	ci
	)

◆ ~ON_MeshComponentRef()

ON_MeshComponentRef::~ON_MeshComponentRef ( )

Member Function Documentation

◆ ComponentIndex()

ON_COMPONENT_INDEX ON_MeshComponentRef::ComponentIndex ( ) const

overridevirtual

Override of the virtual ON_Geometry::ComponentIndex().

Returns: A mesh component index for the face. The type is ON_COMPONENT_INDEX::mesh_face and the index is the index into the ON_Mesh.m_F[] array.

Reimplemented from ON_Geometry.

◆ Dimension()

int ON_MeshComponentRef::Dimension ( ) const

overridevirtual

overrides of virtual ON_Geometry functions

Reimplemented from ON_Geometry.

◆ Dump()

void ON_MeshComponentRef::Dump ( ON_TextLog & ) const

overridevirtual

Creates a text dump of the object.

Dump() is intended for debugging and is not suitable for creating high quality text descriptions of an object.

The default implementations of this virtual function prints the class's name.

Reimplemented from ON_Object.

◆ GetBBox()

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

overridevirtual

virtual ON_Geometry GetBBox override

Reimplemented from ON_Geometry.

◆ GetMeshFace()

unsigned int ON_MeshComponentRef::GetMeshFace ( const class ON_MeshFace *& mesh_face ) const

Returns: If the component is a face or an ngon made of a single face, this returns the face. Otherwise null is returned.

The best way to write code that works with triangle, quad and ngons is to use the ON_MeshComponent::MeshNgon(ngon_buffer).

◆ GetMeshTopologyEdge()

unsigned int ON_MeshComponentRef::GetMeshTopologyEdge ( const struct ON_MeshTopologyEdge *& tope ) const

◆ GetMeshTopologyEdgeAndLine()

unsigned int ON_MeshComponentRef::GetMeshTopologyEdgeAndLine	(	const struct ON_MeshTopologyEdge *&	tope,
		ON_Line &	line
	)		const

Parameters

line	[out] If the component is an edge, the 3d line is returned here.

Returns: If the component is an edge, this returns the edge. Otherwise null is returned.

◆ GetMeshTopologyEdgeLine()

unsigned int ON_MeshComponentRef::GetMeshTopologyEdgeLine ( class ON_Line & line ) const

◆ GetMeshTopologyVertex()

unsigned int ON_MeshComponentRef::GetMeshTopologyVertex ( const struct ON_MeshTopologyVertex *& topv ) const

Returns: If the component is a vertex and mesh topology exists or the component is a mesh topology vertex, then this returns the mesh topology vertex index. Otherwise ON_UNSET_UINT_INDEX is returned.

◆ GetMeshTopologyVertexAndPoint()

unsigned int ON_MeshComponentRef::GetMeshTopologyVertexAndPoint	(	const struct ON_MeshTopologyVertex *&	topv,
		class ON_3dPoint &	point
	)		const

Returns: If the component is a vertex and mesh topology exists or the component is a mesh topology vertex, then this returns the mesh topology vertex index. Otherwise ON_UNSET_UINT_INDEX is returned.

◆ GetMeshTopologyVertexPoint()

unsigned int ON_MeshComponentRef::GetMeshTopologyVertexPoint ( class ON_3dPoint & point ) const

Returns: If the component is a vertex and mesh topology exists or the component is a mesh topology vertex, then this returns the mesh topology vertex index. Otherwise ON_UNSET_UINT_INDEX is returned.

◆ GetVertexPoint()

unsigned int ON_MeshComponentRef::GetVertexPoint ( class ON_3dPoint & point ) const

Parameters

point [out] location of the vertex

Returns: If the component is a vertex, this returns the vertex index. Otherwise ON_UNSET_UINT_INDEX is returned.

◆ IsValid()

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

overridevirtual

overrides of virtual ON_Object functions

Reimplemented from ON_Geometry.

◆ Mesh()

const class ON_Mesh* ON_MeshComponentRef::Mesh ( ) const

Returns: The referenced mesh.

◆ MeshFace()

const class ON_MeshFace* ON_MeshComponentRef::MeshFace ( ) const

Returns: If the component is a face or an ngon made of a single face, this returns the face. Otherwise null is returned.

The best way to write code that works with triangle, quad and ngons is to use the ON_MeshComponent::MeshNgon(ngon_buffer).

◆ MeshFaceIndex()

unsigned int ON_MeshComponentRef::MeshFaceIndex ( ) const

Returns: If the component is a face or an ngon containing a single face, this returns the face index. Otherwise ON_UNSET_UINT_INDEX is returned.

The best way to write code that works with triangle, quad and ngons is to use the ON_MeshComponent::MeshNgon(ngon_buffer).

◆ MeshNgon() [1/2]

const class ON_MeshNgon* ON_MeshComponentRef::MeshNgon ( class ON_MeshNgonBuffer & ngon_buffer ) const

Returns

If the component references to an ON_MeshNgon in the mesh, then a pointer to this ngon is returned.
If the component references an ON_MeshFace triangle or quad, then then a single face ON_MeshNgon is created in the memory in ngon_buffer.
Otherwise, null is returned.

◆ MeshNgon() [2/2]

const class ON_MeshNgon* ON_MeshComponentRef::MeshNgon ( ) const

Returns: If the component is an ngon or a face in an ngon, this returns the ngon. Otherwise null is returned.

The best way to write code that works with triangle, quad and ngons is to use the ON_MeshComponent::MeshNgon(ngon_buffer).

◆ MeshNgonIndex()

unsigned int ON_MeshComponentRef::MeshNgonIndex ( ) const

Returns: If the component is an ngon or a face in an ngon, this returns the ngon index. Otherwise ON_UNSET_UINT_INDEX is returned.

The best way to write code that works with triangle, quad and ngons is to use the ON_MeshComponent::MeshNgon(ngon_buffer).

◆ MeshTopology()

const class ON_MeshTopology* ON_MeshComponentRef::MeshTopology ( ) const

Returns: If the mesh topology exists or the component references a mesh topology component, then this returns a pointer to the mesh topology. Otherwise null is returned.

◆ MeshTopologyEdge()

const struct ON_MeshTopologyEdge* ON_MeshComponentRef::MeshTopologyEdge ( ) const

Returns: If the component is an edge, this returns the edge. Otherwise null is returned.

◆ MeshTopologyEdgeIndex()

unsigned int ON_MeshComponentRef::MeshTopologyEdgeIndex ( ) const

Returns: If the component is a mesh topology edge, this returns the mesh topology edge index. Otherwise ON_UNSET_UINT_INDEX is returned.

◆ MeshTopologyVertex()

const struct ON_MeshTopologyVertex* ON_MeshComponentRef::MeshTopologyVertex ( ) const

Returns: If the component is a vertex and mesh topology exists or the component is a mesh topology vertex, then this returns a pointer to the mesh topology vertex index. Otherwise null is returned.

◆ MeshTopologyVertexIndex()

unsigned int ON_MeshComponentRef::MeshTopologyVertexIndex ( ) const

Returns: If the component is a vertex and mesh topology exists or the component is a mesh topology vertex, then this returns the mesh topology vertex index. Otherwise ON_UNSET_UINT_INDEX is returned.

◆ ObjectType()

ON::object_type ON_MeshComponentRef::ObjectType ( ) const

overridevirtual

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

Returns

ON::object_type enum value.

The default implementation of this virtual function returns ON::unknown_object_type

Reimplemented from ON_Object.

◆ operator=()

ON_MeshComponentRef& ON_MeshComponentRef::operator= ( const ON_MeshComponentRef & )

◆ Set()

void ON_MeshComponentRef::Set	(	const class ON_Mesh *	mesh,
		ON_COMPONENT_INDEX	ci
	)

◆ SizeOf()

unsigned int ON_MeshComponentRef::SizeOf ( ) const

overridevirtual

Returns: An estimate of the amount of memory the class uses in bytes.

Reimplemented from ON_Object.

◆ Transform()

bool ON_MeshComponentRef::Transform ( const ON_Xform & xform )

overridevirtual

Transforms the object.

Parameters

xform [in] transformation to apply to object. If xform.IsSimilarity() is zero, then you may want to call MakeSquishy() before calling Transform.

Classes derived from ON_Geometry should call ON_Geometry::Transform() to handle user data transformations and then transform their definition.

See also: ON_Geometry::IsDeformable();,

Reimplemented from ON_Geometry.

◆ VertexIndex()

unsigned int ON_MeshComponentRef::VertexIndex ( ) const

Returns: If the component is a vertex, this returns the vertex index. Otherwise ON_UNSET_UINT_INDEX is returned.

◆ VertexPoint()

ON_3dPoint ON_MeshComponentRef::VertexPoint ( ) const

Returns: If the component is a mesh vertex or mesh topology vertex, then this returns the vertex location. Otherwise ON_3dPoint::UnsetPoint is returned.

Member Data Documentation

◆ Unset

const ON_MeshComponentRef ON_MeshComponentRef::Unset

static

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ON_MeshComponentRef() [1/2]

◆ ON_MeshComponentRef() [2/2]

◆ ~ON_MeshComponentRef()

Member Function Documentation

◆ ComponentIndex()

◆ Dimension()

◆ Dump()

◆ GetBBox()

◆ GetMeshFace()

◆ GetMeshTopologyEdge()

◆ GetMeshTopologyEdgeAndLine()

◆ GetMeshTopologyEdgeLine()

◆ GetMeshTopologyVertex()

◆ GetMeshTopologyVertexAndPoint()

◆ GetMeshTopologyVertexPoint()

◆ GetVertexPoint()

◆ IsValid()

◆ Mesh()

◆ MeshFace()

◆ MeshFaceIndex()

◆ MeshNgon() [1/2]

◆ MeshNgon() [2/2]

◆ MeshNgonIndex()

◆ MeshTopology()

◆ MeshTopologyEdge()

◆ MeshTopologyEdgeIndex()

◆ MeshTopologyVertex()

◆ MeshTopologyVertexIndex()

◆ ObjectType()

◆ operator=()

◆ Set()

◆ SizeOf()

◆ Transform()

◆ VertexIndex()

◆ VertexPoint()

Member Data Documentation

◆ Unset