Brep trim information is stored in ON_BrepTrim classes. ON_Brep.m_T[] is an array of all the trim in the brep. More...

#include <opennurbs_brep.h>

Inheritance diagram for ON_BrepTrim:

Public Types
enum	TYPE { unknown = 0, boundary = 1, mated = 2, seam = 3, singular = 4, crvonsrf = 5, ptonsrf = 6, slit = 7, trim_type_count = 8, force_32_bit_trim_type = 0xFFFFFFFF }
	types of trim - access through m_type member. Also see m_iso and ON_Surface::ISO More...

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

Public Member Functions
	ON_BrepTrim ()

	ON_BrepTrim (int)

bool	AttachToEdge (int edge_index, bool bRev3d)
	Expert user function. Attaches a trim to an edge. More...

ON_Brep *	Brep () const

bool	ChangeTrimCurve (int c2i)
	Interface. More...

ON_COMPONENT_INDEX	ComponentIndex () const override
	virtual ON_Geometry::ComponentIndex() override More...

void	DestroyPspaceInformation ()
	Destroy parameter space information. Currently, this involves destroying m_pline and m_pbox. Parameter space information should be destroyed when the location of a trim curve is changed. More...

void	DestroyRuntimeCache (bool bDelete=true) override
	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...

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

ON_BrepEdge *	Edge () const

int	EdgeCurveIndexOf () const

const ON_Curve *	EdgeCurveOf () const

ON_BrepFace *	Face () const

int	FaceIndexOf () const

bool	IsSeam () const

bool	IsSlit () const

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

ON_BrepLoop *	Loop () const

bool	m__legacy_flags_Get (int , int ) const

void	m__legacy_flags_Set (int, int)
	values stored in legacy file formats - ignore More...

ON_BrepTrim &	operator= (const ON_BrepTrim &)

bool	Read (ON_BinaryArchive &) override
	Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...

bool	RemoveFromEdge (bool bRemoveFromStartVertex, bool bRemoveFromEndVertex)
	Expert user function. Removes a trim from an edge. More...

bool	Reverse () override
	Reverse the direction of the curve. More...

unsigned int	SizeOf () const override
	virtual ON_Object::SizeOf override More...

int	SurfaceIndexOf () const

const ON_Surface *	SurfaceOf () const

bool	TransformTrim (const ON_Xform &xform)
	Expert user tool that tranforms all the parameter space (2d) trimming curves in this loop. Only 2d curve geometry is changed. The caller is responsible for reversing loops, toggle m_bRev, flags, etc. More...

int	TrimCurveIndexOf () const

const ON_Curve *	TrimCurveOf () const

void	UnsetPlineEdgeParameters ()
	When an edge is modified, the m_pline[].e values need to be set to ON_UNSET_VALUE by calling UnsetPlineEdgeParameters(). More...

ON_BrepVertex *	Vertex (int tvi) const

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

Public Member Functions inherited from ON_CurveProxy
	ON_CurveProxy () ON_NOEXCEPT

	ON_CurveProxy (const ON_CurveProxy &)

	ON_CurveProxy (const ON_Curve *)

	ON_CurveProxy (const ON_Curve *, ON_Interval)

virtual	~ON_CurveProxy ()

ON__UINT32	DataCRC (ON__UINT32 current_remainder) const override
	virtual ON_Object::DataCRC override More...

int	Degree () const override
	Returns maximum algebraic degree of any span or a good estimate if curve spans are not algebraic. More...

void	DestroyRuntimeCache (bool bDelete=true) override
	virtual ON_Object::DestroyRuntimeCache override More...

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

ON_Interval	Domain () const override
	ON_Curve overrides. More...

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

ON_Curve *	DuplicateCurve () const override
	Get a duplicate of the curve. More...

bool	Evaluate (double, int, int, double , int=0, int =0) const override
	This evaluator actually does all the work. The other ON_Curve evaluation tools call this virtual function. More...

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

bool	GetCurveParameterFromNurbFormParameter (double, double *) const override
	virtual ON_Curve::GetCurveParameterFromNurbFormParameter override More...

bool	GetNextDiscontinuity (ON::continuity c, double t0, double t1, double t, int hint=nullptr, int *dtype=nullptr, double cos_angle_tolerance=ON_DEFAULT_ANGLE_TOLERANCE_COSINE, double curvature_tolerance=ON_SQRT_EPSILON) const override
	Search for a derivatitive, tangent, or curvature discontinuity. More...

int	GetNurbForm (ON_NurbsCurve &, double=0.0, const ON_Interval *=nullptr) const override
	Get a NURBS curve representation of this curve. More...

bool	GetNurbFormParameterFromCurveParameter (double, double *) const override
	virtual ON_Curve::GetNurbFormParameterFromCurveParameter override More...

bool	GetParameterTolerance (double, double , double ) const override
	(optional - override if curve is piecewise smooth) More...

bool	GetSpanVector (double *) const override
	Get number of parameters of "knots". More...

int	HasNurbForm () const override
	Does a NURBS curve representation of this curve. More...

bool	IsArc (const ON_Plane =nullptr, ON_Arc =nullptr, double=ON_ZERO_TOLERANCE) const override
	Test a curve to see if the locus if its points is an arc or circle. More...

bool	IsClosed (void) const override
	Test a curve to see if it is closed. More...

bool	IsContinuous (ON::continuity c, double t, int *hint=nullptr, double point_tolerance=ON_ZERO_TOLERANCE, double d1_tolerance=ON_ZERO_TOLERANCE, double d2_tolerance=ON_ZERO_TOLERANCE, double cos_angle_tolerance=ON_DEFAULT_ANGLE_TOLERANCE_COSINE, double curvature_tolerance=ON_SQRT_EPSILON) const override
	Test continuity at a curve parameter value. More...

bool	IsInPlane (const ON_Plane &, double=ON_ZERO_TOLERANCE) const override
	Test a curve to see if it lies in a specific plane. More...

bool	IsLinear (double=ON_ZERO_TOLERANCE) const override
	Test a curve to see if the locus if its points is a line segment. More...

bool	IsPeriodic (void) const override
	Test a curve to see if it is periodic. More...

bool	IsPlanar (ON_Plane *=nullptr, double=ON_ZERO_TOLERANCE) const override
	Test a curve to see if it is planar. More...

int	IsPolyline (ON_SimpleArray< ON_3dPoint > pline_points=nullptr, ON_SimpleArray< double > pline_t=nullptr) const override
	virtual override of ON_Curve::IsPolyline More...

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

ON_CurveProxy &	operator= (const ON_CurveProxy &)

const ON_Curve *	ProxyCurve () const

ON_Interval	ProxyCurveDomain () const

bool	ProxyCurveIsReversed () const

bool	Read (ON_BinaryArchive &) override
	Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...

double	RealCurveParameter (double t) const

bool	Reverse () override
	Reverse the direction of the curve. More...

bool	SetDomain (double t0, double t1) override
	Set the domain of the curve More...

bool	SetDomain (ON_Interval domain)

void	SetProxyCurve (const ON_Curve *real_curve)
	Sets the curve geometry that "this" is a proxy for. Sets proxy domain to proxy_curve->Domain(). More...

void	SetProxyCurve (const ON_Curve *real_curve, ON_Interval real_curve_subdomain)
	Sets the curve geometry that "this" is a proxy for. Sets proxy domain to proxy_curve->Domain(). More...

bool	SetProxyCurveDomain (ON_Interval proxy_curve_subdomain)
	Sets portion of the "real" curve that this proxy represents. Does NOT change the domain of "this" curve. More...

unsigned int	SizeOf () const override
	virtual ON_Object::SizeOf override More...

int	SpanCount () const override
	Get number of nonempty smooth (c-infinity) spans in curve More...

bool	Split (double t, ON_Curve &left_side, ON_Curve &right_side) const override
	override of virtual ON_Curve::Split More...

double	ThisCurveParameter (double real_curve_parameter) const

bool	Transform (const ON_Xform &) override
	overrides virtual ON_Geometry::Transform(). ON_Curve::Transform() calls ON_Geometry::Transform(xform), which calls ON_Object::TransformUserData(xform), and then calls this->DestroyCurveTree(). More...

bool	Trim (const ON_Interval &domain) override
	override of virtual ON_Curve::Trim More...

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

Public Member Functions inherited from ON_Curve
	ON_Curve () ON_NOEXCEPT

	ON_Curve (const ON_Curve &)

virtual	~ON_Curve ()

virtual bool	ChangeClosedCurveSeam (double t)
	If this curve is closed, then modify it so that the start/end point is at curve parameter t. More...

virtual bool	ChangeDimension (int desired_dimension)
	Change the dimension of a curve. More...

ON_3dVector	CurvatureAt (double t) const
	Evaluate the curvature vector at a parameter. More...

ON_3dVector	DerivativeAt (double t) const
	Evaluate first derivative at a parameter. More...

void	DestroyCurveTree ()
	Destroys the runtime curve tree used to speed closest point and intersection calcuations. More...

bool	Ev1Der (double t, ON_3dPoint &point, ON_3dVector &first_derivative, int side=0, int *hint=0) const
	Evaluate first derivative at a parameter with error checking. More...

bool	Ev2Der (double t, ON_3dPoint &point, ON_3dVector &first_derivative, ON_3dVector &second_derivative, int side=0, int *hint=0) const
	Evaluate second derivative at a parameter with error checking. More...

bool	EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const override
	virtual ON_Geometry override More...

bool	EvCurvature (double t, ON_3dPoint &point, ON_3dVector &tangent, ON_3dVector &kappa, int side=0, int *hint=0) const
	Evaluate unit tangent and curvature at a parameter with error checking. More...

bool	EvPoint (double t, ON_3dPoint &point, int side=0, int *hint=0) const
	Evaluate point at a parameter with error checking. More...

bool	EvTangent (double t, ON_3dPoint &point, ON_3dVector &tangent, int side=0, int *hint=0) const
	Evaluate unit tangent at a parameter with error checking. More...

virtual bool	Extend (const ON_Interval &domain)
	Pure virtual function. Default returns false. Where possible, analytically extends curve to include domain. More...

bool	FirstSpanIsLinear (double min_length, double tolerance) const

bool	FirstSpanIsLinear (double min_length, double tolerance, ON_Line *span_line) const

bool	FrameAt (double t, ON_Plane &plane) const
	Return a 3d frame at a parameter. More...

bool	GetDomain (double t0, double t1) const
	curve interface More...

virtual bool	GetSpanVectorIndex (double t, int side, int span_vector_index, ON_Interval span_domain) const

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	IsArcAt (double t, const ON_Plane plane=0, ON_Arc arc=0, double tolerance=ON_ZERO_TOLERANCE, double t0=0, double t1=0) const

bool	IsClosable (double tolerance, double min_abs_size=0.0, double min_rel_size=10.0) const
	Decide if it makes sense to close off this curve by moving the endpoint to the start based on start-end gap size and length of curve as approximated by chord defined by 6 points. More...

virtual bool	IsEllipse (const ON_Plane plane=nullptr, ON_Ellipse ellipse=nullptr, double tolerance=ON_ZERO_TOLERANCE) const

bool	LastSpanIsLinear (double min_length, double tolerance) const

bool	LastSpanIsLinear (double min_length, double tolerance, ON_Line *span_line) const

ON_NurbsCurve *	NurbsCurve (ON_NurbsCurve pNurbsCurve=nullptr, double tolerance=0.0, const ON_Interval subdomain=nullptr) const
	Get a NURBS curve representation of this curve. More...

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

ON_Curve &	operator= (const ON_Curve &)

ON_3dPoint	PointAt (double t) const
	Evaluate point at a parameter. More...

ON_3dPoint	PointAtEnd () const
	Evaluate point at the end of the curve. More...

ON_3dPoint	PointAtStart () const
	Evaluate point at the start of the curve. More...

bool	SetDomain (ON_Interval domain)
	Set the domain of the curve. More...

virtual bool	SetEndPoint (ON_3dPoint end_point)
	Force the curve to end at a specified point. More...

virtual bool	SetStartPoint (ON_3dPoint start_point)
	Force the curve to start at a specified point. More...

ON_3dVector	TangentAt (double t) const
	Evaluate unit tangent vector at a parameter. 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...

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

virtual bool	IsDeformable () const

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

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 bool	DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
	Delete the portions of the object identified in ci_list[]. 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...

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
double	m__legacy_2d_tol = ON_UNSET_VALUE

double	m__legacy_3d_tol = ON_UNSET_VALUE

int	m__legacy_flags = 0

bool	m_bRev3d = false
	true if the 2d trim and 3d edge have opposite orientations. More...

int	m_c2i = -1
	index of the 2d parameter space trimming curve More...

int	m_ei = -1
	index of 3d edge (-1 if ON_BrepTrim is singular) More...

ON_Surface::ISO	m_iso = ON_Surface::not_iso

int	m_li = -1
	index of loop that uses this trim More...

ON_BoundingBox	m_pbox

ON_SimpleArray< ON_BrepTrimPoint >	m_pline

ON_ComponentStatus	m_status = ON_ComponentStatus::NoneSet

double	m_tolerance [2]

int	m_trim_index = -1

ON_U	m_trim_user

TYPE	m_type = ON_BrepTrim::unknown

int	m_vi [2]

Friends
class	ON_Brep

Additional Inherited Members
Static Public Attributes inherited from ON_Geometry
static const ON_Geometry	Unset

Protected Member Functions inherited from ON_CurveProxy
void	SetProxyCurveIsReversed (bool bReversed)

Protected Member Functions inherited from ON_Curve
bool	ParameterSearch (double t, int &index, bool bEnableSnap, const ON_SimpleArray< double > &m_t, double RelTol=ON_SQRT_EPSILON) const
	Lookup a parameter in the m_t array, optionally using a built in snap tolerance to snap a parameter value to an element of m_t. This function is used by some types derived from ON_Curve to snap parameter values More...

Detailed Description

Brep trim information is stored in ON_BrepTrim classes. ON_Brep.m_T[] is an array of all the trim in the brep.

An ON_BrepTrim is derived from ON_CurveProxy so the the trim can supply easy to use evaluation tools via the ON_Curve virtual member functions.

Note well that the domains and orientations of the curve m_C2[trim.m_c2i] and the trin as a curve may not agree.

Member Enumeration Documentation

◆ TYPE

enum ON_BrepTrim::TYPE

types of trim - access through m_type member. Also see m_iso and ON_Surface::ISO

Enumerator
unknown
boundary
mated
seam
singular
crvonsrf
ptonsrf
slit
trim_type_count
force_32_bit_trim_type

Constructor & Destructor Documentation

◆ ON_BrepTrim() [1/2]

ON_BrepTrim::ON_BrepTrim ( )

◆ ON_BrepTrim() [2/2]

ON_BrepTrim::ON_BrepTrim ( int )

Member Function Documentation

◆ AttachToEdge()

bool ON_BrepTrim::AttachToEdge	(	int	edge_index,
		bool	bRev3d
	)

Expert user function. Attaches a trim to an edge.

Parameters

edge_index	[in] index of an edge.
bRev3d	[in] value for trim's m_bRev3d field.

If the trim is attached to an edge (m_ei>=0), then the trim is removed from the edge and the edge's m_ti[] list. The trim's tolerance values are not changed.

◆ Brep()

ON_Brep* ON_BrepTrim::Brep ( ) const

Returns: Brep that this trim belongs to.

◆ ChangeTrimCurve()

bool ON_BrepTrim::ChangeTrimCurve ( int c2i )

Interface.

Expert user tool that replaces the 2d curve geometry of a trim Parameters; c2i - [in] brep 2d curve index of new curve

Returns: True if successful.

Sets m_c2i, calls SetProxyCurve, cleans runtime caches, and updates m_pbox.

@verbatim
      ON_Curve* pCurve = ...;
      int c2i = brep.AddTrimCurve(pCurve);
      trim.ChangeTrimCurve(c2i);
@endverbatim

◆ ComponentIndex()

ON_COMPONENT_INDEX ON_BrepTrim::ComponentIndex ( ) const

overridevirtual

virtual ON_Geometry::ComponentIndex() override

Reimplemented from ON_Geometry.

◆ DestroyPspaceInformation()

void ON_BrepTrim::DestroyPspaceInformation ( )

Destroy parameter space information. Currently, this involves destroying m_pline and m_pbox. Parameter space information should be destroyed when the location of a trim curve is changed.

◆ DestroyRuntimeCache()

void ON_BrepTrim::DestroyRuntimeCache ( bool bDelete = true )

overridevirtual

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.

Parameters

bDelete [in] if true, any cached information is properly deleted. If false, any cached information is simply discarded. This is useful when the cached information may be in alternate memory pools that are managed in nonstandard ways.

Reimplemented from ON_Object.

◆ Dump()

void ON_BrepTrim::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.

◆ Edge()

ON_BrepEdge* ON_BrepTrim::Edge ( ) const

Returns: Brep edge this trim uses or belongs to. This will be nullptr for singular trims.

◆ EdgeCurveIndexOf()

int ON_BrepTrim::EdgeCurveIndexOf ( ) const

Returns: brep.m_C3[] 3d curve index of the 3d curve geometry used by this trim or -1.

◆ EdgeCurveOf()

const ON_Curve* ON_BrepTrim::EdgeCurveOf ( ) const

Returns: 3d curve geometry used by this trim or nullptr.

◆ Face()

ON_BrepFace* ON_BrepTrim::Face ( ) const

Returns: Brep face this trim belongs to.

◆ FaceIndexOf()

int ON_BrepTrim::FaceIndexOf ( ) const

Returns: brep.m_F[] face index of the face used by this trim or -1.

◆ IsSeam()

bool ON_BrepTrim::IsSeam ( ) const

Returns: True if the trim satisfies these four criteria. 1) is part of a loop 2) is connected to a 3d edge 3) one other trim from the same loop is connected to the edge 4) the 2d trim curve for this trim lies along the side of the face's parameter space and the 2d curve for the other trim lies on the opposite side of the face's parameter space.

In order for IsSeam() to work correctly, the m_type and m_iso fields must be set correctly. In V4 SR1, this function will be removed and ON_BrepTrim::slit will be added as a type.

◆ IsSlit()

bool ON_BrepTrim::IsSlit ( ) const

Returns: True if the trim satisfies these four criteria. 1) is part of a loop 2) is connected to a 3d edge 3) one other trim from the same loop is connected to the edge 4) The 2d trim curve for the other trim is the reverse of the 2d trim curve for this trim.

In order for IsSlit() to work correctly, the m_type and m_iso fields must be set correctly. In V4 SR1, this function will be removed and ON_BrepTrim::slit will be added as a type.

◆ IsValid()

bool ON_BrepTrim::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_Object.

◆ Loop()

ON_BrepLoop* ON_BrepTrim::Loop ( ) const

Returns: Brep loop that this trim belongs to.

◆ m__legacy_flags_Get()

bool ON_BrepTrim::m__legacy_flags_Get	(	int *	,
		int *
	)		const

◆ m__legacy_flags_Set()

void ON_BrepTrim::m__legacy_flags_Set	(	int	,
		int
	)

values stored in legacy file formats - ignore

◆ operator=()

ON_BrepTrim& ON_BrepTrim::operator= ( const ON_BrepTrim & )

◆ Read()

bool ON_BrepTrim::Read ( ON_BinaryArchive & binary_archive )

overridevirtual

Low level archive writing tool used by ON_BinaryArchive::ReadObject().

Parameters

binary_archive archive to read from

Returns: Returns true if the read is successful.

Use ON_BinaryArchive::ReadObject() to read objects. This Read() function should read the objects definition back into its data members.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

◆ RemoveFromEdge()

bool ON_BrepTrim::RemoveFromEdge	(	bool	bRemoveFromStartVertex,
		bool	bRemoveFromEndVertex
	)

Expert user function. Removes a trim from an edge.

Parameters

bRemoveFromStartVertex	[in] if true, the trim is removed from its start vertex by setting m_vi[0] to -1.
bRemoveFromEndVertex	[in] if true, the trim is removed from its start vertex by setting m_vi[1] to -1.

If the trim is attached to an edge (m_ei>=0), then the trim is removed from the edge and the edge's m_ti[] list. The trim's m_bRev3d and tolerance values are not changed.

◆ Reverse()

bool ON_BrepTrim::Reverse ( )

overridevirtual

Reverse the direction of the curve.

Returns: true if curve was reversed.

If reveresed, the domain changes from [a,b] to [-b,-a]

Implements ON_Curve.

◆ SizeOf()

unsigned int ON_BrepTrim::SizeOf ( ) const

overridevirtual

virtual ON_Object::SizeOf override

Reimplemented from ON_Object.

◆ SurfaceIndexOf()

int ON_BrepTrim::SurfaceIndexOf ( ) const

Returns: brep.m_S[] surface index of the 3d surface geometry used by this trim or -1.

◆ SurfaceOf()

const ON_Surface* ON_BrepTrim::SurfaceOf ( ) const

Returns: 3d surface geometry used by this trim or nullptr

◆ TransformTrim()

bool ON_BrepTrim::TransformTrim ( const ON_Xform & xform )

Expert user tool that tranforms all the parameter space (2d) trimming curves in this loop. Only 2d curve geometry is changed. The caller is responsible for reversing loops, toggle m_bRev, flags, etc.

Parameters

xform [in] Transformation applied to 2d curve geometry. Returns True if successful. If false is returned, the brep may be invalid.

◆ TrimCurveIndexOf()

int ON_BrepTrim::TrimCurveIndexOf ( ) const

Returns: brep.m_C2[] 2d curve index of the 2d curve geometry used by this trim or -1.

◆ TrimCurveOf()

const ON_Curve* ON_BrepTrim::TrimCurveOf ( ) const

Returns: 2d curve geometry used by this trim or nullptr

◆ UnsetPlineEdgeParameters()

void ON_BrepTrim::UnsetPlineEdgeParameters ( )

When an edge is modified, the m_pline[].e values need to be set to ON_UNSET_VALUE by calling UnsetPlineEdgeParameters().

◆ Vertex()

ON_BrepVertex* ON_BrepTrim::Vertex ( int tvi ) const

Parameters

tvi	[in] 0 or 1

Returns: Brep vertex at specified end of the trim.

◆ Write()

bool ON_BrepTrim::Write ( ON_BinaryArchive & binary_archive ) const

overridevirtual

Low level archive writing tool used by ON_BinaryArchive::WriteObject().

Parameters

binary_archive archive to write to

Returns: Returns true if the write is successful.

Use ON_BinaryArchive::WriteObject() to write objects. This Write() function should just write the specific definition of this object. It should not write and any chunk typecode or length information.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

Friends And Related Function Documentation

◆ ON_Brep

friend class ON_Brep

friend

Member Data Documentation

◆ m__legacy_2d_tol

double ON_BrepTrim::m__legacy_2d_tol = ON_UNSET_VALUE

◆ m__legacy_3d_tol

double ON_BrepTrim::m__legacy_3d_tol = ON_UNSET_VALUE

◆ m__legacy_flags

int ON_BrepTrim::m__legacy_flags = 0

◆ m_bRev3d

bool ON_BrepTrim::m_bRev3d = false

true if the 2d trim and 3d edge have opposite orientations.

◆ m_c2i

int ON_BrepTrim::m_c2i = -1

index of the 2d parameter space trimming curve

◆ m_ei

int ON_BrepTrim::m_ei = -1

index of 3d edge (-1 if ON_BrepTrim is singular)

◆ m_iso

ON_Surface::ISO ON_BrepTrim::m_iso = ON_Surface::not_iso

◆ m_li

int ON_BrepTrim::m_li = -1

index of loop that uses this trim

◆ m_pbox

ON_BoundingBox ON_BrepTrim::m_pbox

◆ m_pline

ON_SimpleArray<ON_BrepTrimPoint> ON_BrepTrim::m_pline

◆ m_status

ON_ComponentStatus ON_BrepTrim::m_status = ON_ComponentStatus::NoneSet

mutable

◆ m_tolerance

double ON_BrepTrim::m_tolerance[2]

m_tolerance[0] = accuracy of parameter space curve in first ( "u" ) parameter

m_tolerance[1] = accuracy of parameter space curve in second ( "v" ) parameter

A value of ON_UNSET_VALUE indicates that the tolerance should be computed. If the value >= 0.0, then the tolerance is set. If the value is ON_UNSET_VALUE, then the tolrance needs to be computed.

If the trim is not singular, then the trim must have an edge. If P is a 3d point on the edge's curve and surface(u,v) = Q is the point on the surface that is closest to P, then there must be a parameter t in the interval [m_t[0], m_t[1]] such that

|u - curve2d(t)[0]| <= m_tolerance[0]

and

|v - curve2d(t)[1]| <= m_tolerance[1]

If P is the 3d point for the vertex brep.m_V[m_vi[k]] and (uk,vk) is the corresponding end of the trim's parameter space curve, then there must be a surface parameter (u,v) such that:

the distance from the 3d point surface(u,v) to P is <= brep.m_V[m_vi[k]].m_tolerance,
|u-uk| <= m_tolerance[0].
|v-vk| <= m_tolerance[1].

◆ m_trim_index

int ON_BrepTrim::m_trim_index = -1

◆ m_trim_user

ON_U ON_BrepTrim::m_trim_user

mutable

◆ m_type

TYPE ON_BrepTrim::m_type = ON_BrepTrim::unknown

◆ m_vi

int ON_BrepTrim::m_vi[2]

Public Types

Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TYPE

Constructor & Destructor Documentation

◆ ON_BrepTrim() [1/2]

◆ ON_BrepTrim() [2/2]

Member Function Documentation

◆ AttachToEdge()

◆ Brep()

◆ ChangeTrimCurve()

◆ ComponentIndex()

◆ DestroyPspaceInformation()

◆ DestroyRuntimeCache()

◆ Dump()

◆ Edge()

◆ EdgeCurveIndexOf()

◆ EdgeCurveOf()

◆ Face()

◆ FaceIndexOf()

◆ IsSeam()

◆ IsSlit()

◆ IsValid()

◆ Loop()

◆ m__legacy_flags_Get()

◆ m__legacy_flags_Set()

◆ operator=()

◆ Read()

◆ RemoveFromEdge()

◆ Reverse()

◆ SizeOf()

◆ SurfaceIndexOf()

◆ SurfaceOf()

◆ TransformTrim()

◆ TrimCurveIndexOf()

◆ TrimCurveOf()

◆ UnsetPlineEdgeParameters()

◆ Vertex()

◆ Write()

Friends And Related Function Documentation

◆ ON_Brep

Member Data Documentation

◆ m__legacy_2d_tol

◆ m__legacy_3d_tol

◆ m__legacy_flags

◆ m_bRev3d

◆ m_c2i

◆ m_ei

◆ m_iso

◆ m_li

◆ m_pbox

◆ m_pline

◆ m_status

◆ m_tolerance

◆ m_trim_index

◆ m_trim_user

◆ m_type

◆ m_vi