#include <opennurbs_detail.h>

Inheritance diagram for ON_DetailView:

Public Member Functions
	ON_DetailView ()

	~ON_DetailView ()

int	Dimension () const override

void	Dump (ON_TextLog &) const override

bool	GetBBox (double boxmin, double boxmax, bool bGrowBox=false) const override
	virtual ON_Geometry GetBBox override 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	IsValid (class ON_TextLog *text_log=nullptr) const override

void	MemoryRelocate () override

ON::object_type	ObjectType () const override
	returns ON::detail_object More...

bool	Read (ON_BinaryArchive &binary_archive) override

unsigned int	SizeOf () const override

bool	Transform (const ON_Xform &xform) override

bool	UpdateFrustum (ON::LengthUnitSystem model_units, ON::LengthUnitSystem paper_units)
	Update frustum to match bounding box and detail scale. More...

bool	Write (ON_BinaryArchive &binary_archive) const override

Public Member Functions inherited from ON_Geometry
	ON_Geometry ()=default

	ON_Geometry (const ON_Geometry &)=default

	~ON_Geometry ()=default

ON_BoundingBox	BoundingBox () const

virtual class ON_Brep *	BrepForm (class ON_Brep *brep=nullptr) const

virtual void	ClearBoundingBox ()

virtual ON_COMPONENT_INDEX	ComponentIndex () const

virtual bool	EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const

bool	GetBoundingBox (ON_3dPoint &bbox_min, ON_3dPoint &bbox_max, bool bGrowBox=false) const

bool	GetBoundingBox (ON_BoundingBox &bbox, bool bGrowBox=false) const

virtual bool	HasBrepForm () const

virtual bool	IsDeformable () const

virtual bool	IsMorphable () const

bool	IsValid (class ON_TextLog *text_log=nullptr) const override

virtual bool	MakeDeformable ()

virtual bool	Morph (const class ON_SpaceMorph &morph)

ON_Geometry &	operator= (const ON_Geometry &)=default

bool	Rotate (double rotation_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)

bool	Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)

bool	Scale (double scale_factor)

virtual bool	SwapCoordinates (int i, int j)

const ON_BoundingBox	TightBoundingBox () const

bool	Translate (const ON_3dVector &translation_vector)

Public Member Functions inherited from ON_Object
	ON_Object () ON_NOEXCEPT

	ON_Object (const ON_Object &)

virtual	~ON_Object ()

virtual ON_AggregateComponentStatus	AggregateComponentStatus () const

bool	AttachUserData (class ON_UserData *pUserData)

unsigned int	ClearAllComponentStates () const

virtual unsigned int	ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const

virtual unsigned int	ClearComponentStates (ON_ComponentStatus states_to_clear) const

void	CopyUserData (const ON_Object &source_object)

unsigned int	CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)

virtual ON__UINT32	DataCRC (ON__UINT32 current_remainder) const

virtual bool	DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)

virtual void	DestroyRuntimeCache (bool bDelete=true)

bool	DetachUserData (class ON_UserData *pUserData)

void	EmergencyDestroy ()

class ON_UserData *	FirstUserData () const

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

bool	GetUserString (const wchar_t *key, ON_wString &string_value) const

int	GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const

int	GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const

bool	IsCorrupt (bool bRepair, bool bSilentError, class ON_TextLog *text_log) const

bool	IsKindOf (const ON_ClassId *pClassId) const

virtual void	MarkAggregateComponentStatusAsNotCurrent () const

virtual ON_UUID	ModelObjectId () const

void	MoveUserData (ON_Object &source_object)

unsigned int	MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)

ON_Object &	operator= (const ON_Object &)

void	PurgeUserData ()

virtual unsigned int	SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const

virtual unsigned int	SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const

bool	SetUserString (const wchar_t key, const wchar_t string_value)

int	SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)

bool	ThisIsNullptr (bool bSilentError) const

void	TransformUserData (const class ON_Xform &xform)

virtual bool	UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)

int	UserStringCount () const

Public Attributes
ON_NurbsCurve	m_boundary

double	m_page_per_model_ratio

ON_3dmView	m_view

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 }

Static Public Attributes inherited from ON_Geometry
const static ON_Geometry	Unset

Detailed Description

THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY. ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF MERCHANTABILITY ARE HEREBY DISCLAIMED.

For complete openNURBS copyright information see http://www.opennurbs.org.

Constructor & Destructor Documentation

◆ ON_DetailView()

ON_DetailView::ON_DetailView ( )

◆ ~ON_DetailView()

ON_DetailView::~ON_DetailView ( )

Member Function Documentation

◆ Dimension()

int ON_DetailView::Dimension ( ) const

overridevirtual

virtual ON_Geometry overrides The m_boundary determines all bounding boxes

Reimplemented from ON_Geometry.

◆ Dump()

void ON_DetailView::Dump ( ON_TextLog & ) const

overridevirtual

Description: Creates a text dump of the object. Remarks: 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_DetailView::GetBBox	(	double *	boxmin,
		double *	boxmax,
		bool	bGrowBox = `false`
	)		const

overridevirtual

virtual ON_Geometry GetBBox override

Reimplemented from ON_Geometry.

◆ GetTightBoundingBox()

bool ON_DetailView::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.

◆ IsValid()

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

overridevirtual

Description: 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 english description of the reason the object is not valid is appended 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: @untitled table true object is valid false object is invalid, uninitialized, etc.

Reimplemented from ON_Object.

◆ MemoryRelocate()

void ON_DetailView::MemoryRelocate ( )

overridevirtual

C++ defaults for copy constructor and operator= work fine. virtual ON_Object overrides

Reimplemented from ON_Object.

◆ ObjectType()

ON::object_type ON_DetailView::ObjectType ( ) const

overridevirtual

returns ON::detail_object

Reimplemented from ON_Object.

◆ Read()

bool ON_DetailView::Read ( ON_BinaryArchive & binary_archive )

overridevirtual

Description: 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. Remarks: 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.

◆ SizeOf()

unsigned int ON_DetailView::SizeOf ( ) const

overridevirtual

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

Reimplemented from ON_Object.

◆ Transform()

bool ON_DetailView::Transform ( const ON_Xform & xform )

overridevirtual

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

Remarks: When overriding this function, be sure to include a call to ON_Object::TransformUserData() which takes care of transforming any ON_UserData that may be attached to the object.

◆ UpdateFrustum()

bool ON_DetailView::UpdateFrustum	(	ON::LengthUnitSystem	model_units,
		ON::LengthUnitSystem	paper_units
	)

Update frustum to match bounding box and detail scale.

◆ Write()

bool ON_DetailView::Write ( ON_BinaryArchive & binary_archive ) const

overridevirtual

Description: 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. Remarks: 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.

Member Data Documentation

◆ m_boundary

ON_NurbsCurve ON_DetailView::m_boundary

2d curve in page layout coordinates in mm (0,0) = lower left corner of page

◆ m_page_per_model_ratio

double ON_DetailView::m_page_per_model_ratio

m_page_per_model_ratio is the ratio of page length / model length where both lengths are in the same unit system (ex. 1/4" on page = 1' in model = 0.25/12 = 0.02083) ( 1mm on page = 1m in model = 1/1000 = 0.001) If m_page_per_model_ratio > 0.0, then the detail is drawn using the specified scale.

◆ m_view

ON_3dmView ON_DetailView::m_view

A view with ON_3dmView::m_view_type = ON::nested_view_type This field is used for IO purposes only. Runtime detail view projection information is on CRhDetailViewObject.

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ON_DetailView()

◆ ~ON_DetailView()

Member Function Documentation

◆ Dimension()

◆ Dump()

◆ GetBBox()

◆ GetTightBoundingBox()

◆ IsValid()

◆ MemoryRelocate()

◆ ObjectType()

◆ Read()

◆ SizeOf()

◆ Transform()

◆ UpdateFrustum()

◆ Write()

Member Data Documentation

◆ m_boundary

◆ m_page_per_model_ratio

◆ m_view