#include <opennurbs_instance.h>
Public Member Functions | |
| ON_InstanceRef ()=default | |
| ON_InstanceRef (const ON_InstanceRef &)=default | |
| ~ON_InstanceRef ()=default | |
| int | Dimension () const override |
| bool | GetBBox (double *boxmin, double *boxmax, bool bGrowBox=false) const override |
| virtual ON_Geometry GetBBox override More... | |
| bool | IsDeformable () const override |
| virtual ON_Geometry::IsDeformable() override More... | |
| bool | IsValid (class ON_TextLog *text_log=nullptr) const override |
| bool | MakeDeformable () override |
| virtual ON_Geometry::MakeDeformable() override More... | |
| ON::object_type | ObjectType () const override |
| ON_InstanceRef & | operator= (const ON_InstanceRef &)=default |
| bool | Read (ON_BinaryArchive &binary_archive) override |
| bool | Transform (const ON_Xform &xform) override |
| 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 | GetTightBoundingBox (class ON_BoundingBox &tight_bbox, bool bGrowBox=false, const class ON_Xform *xform=nullptr) const |
| virtual bool | HasBrepForm () const |
| virtual bool | IsMorphable () const |
| 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) |
| virtual void | Dump (ON_TextLog &) const |
| 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 void | MemoryRelocate () |
| 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) |
| virtual unsigned int | SizeOf () const |
| 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_BoundingBox | m_bbox |
| Bounding box for this reference. More... | |
| ON_UUID | m_instance_definition_uuid = ON_nil_uuid |
| ON_Xform | m_xform = ON_Xform::IdentityTransformation |
| Transformation for this reference. More... | |
Static Public Attributes | |
| static const double | SingularTransformationTolerance |
| Static Public Attributes inherited from ON_Geometry | |
| const static 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 } |
Detailed Description
Description: An ON_InstanceRef is a reference to an instance definition along with transformation to apply to the definition. See Also: ON_InstanceRef
Constructor & Destructor Documentation
◆ ON_InstanceRef() [1/2]
|
default |
◆ ~ON_InstanceRef()
|
default |
◆ ON_InstanceRef() [2/2]
|
default |
Member Function Documentation
◆ Dimension()
|
overridevirtual |
virtual ON_Geometry overrides
Reimplemented from ON_Geometry.
◆ GetBBox()
|
overridevirtual |
virtual ON_Geometry GetBBox override
Reimplemented from ON_Geometry.
◆ IsDeformable()
|
overridevirtual |
virtual ON_Geometry::IsDeformable() override
Reimplemented from ON_Geometry.
◆ IsValid()
|
overridevirtual |
virtual ON_Object overrides
Reimplemented from ON_Geometry.
◆ MakeDeformable()
|
overridevirtual |
virtual ON_Geometry::MakeDeformable() override
Reimplemented from ON_Geometry.
◆ ObjectType()
|
overridevirtual |
Description: 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.
Remarks: The default implementation of this virtual function returns ON::unknown_object_type
Reimplemented from ON_Object.
◆ operator=()
|
default |
◆ Read()
|
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.
◆ Transform()
|
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.
See Also: ON_Geometry::IsDeformable();
Remarks: Classes derived from ON_Geometry should call ON_Geometry::Transform() to handle user data transformations and then transform their definition.
Reimplemented from ON_Geometry.
◆ Write()
|
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_bbox
| ON_BoundingBox ON_InstanceRef::m_bbox |
Bounding box for this reference.
◆ m_instance_definition_uuid
| ON_UUID ON_InstanceRef::m_instance_definition_uuid = ON_nil_uuid |
Unique id of the instance definition (ON_InstanceDefinition) in the instance definition table that defines the geometry used by this reference.
◆ m_xform
| ON_Xform ON_InstanceRef::m_xform = ON_Xform::IdentityTransformation |
Transformation for this reference.
◆ SingularTransformationTolerance
|
static |
Tolerance to use for flagging instance xforms as singular. A valid ON_InstanceRef.m_xform satisfies: true == (m_xform.Inverse()*m_xform).IsIdentity(ON_InstanceRef::SingularTransformationTolerance)
