#include <opennurbs_object_history.h>

Inheritance diagram for ON_HistoryRecord:
ON_ModelComponent ON_Object

Public Types

enum  RECORD_TYPE : unsigned int { RECORD_TYPE::history_parameters = 0, RECORD_TYPE::feature_parameters = 1 }
 
- Public Types inherited from ON_ModelComponent
enum  Attributes : unsigned int {
  NoAttributes = 0U, ComponentSerialNumberAttribute = 0x0001U, TypeAttribute = 0x0002U, ModelSerialNumberAttribute = 0x0004U,
  IdAttribute = 0x0008U, IndexAttribute = 0x0010U, NameAttribute = 0x0020U, ParentIdAttribute = 0x0040U,
  DeletedNameAttribute = 0x0080U, ComponentStatusAttribute = 0x0100U, BinaryArchiveAttributes = 0x78U, AllAttributes = 0x1FFU,
  SystemComponentAttribute = 0x8000U
}
 
enum  Type : unsigned char {
  Type::Unset = 0, Type::Image = 1, Type::TextureMapping = 2, Type::RenderMaterial = 3,
  Type::LinePattern = 4, Type::Layer = 5, Type::Group = 6, Type::TextStyle = 7,
  Type::DimStyle = 8, Type::RenderLight = 9, Type::HatchPattern = 10, Type::InstanceDefinition = 11,
  Type::ModelGeometry = 12, Type::HistoryRecord = 13, Type::Mixed = 0xFE
}
 The ON_ModelComponent::Type enum has a value for each explicit component type and two special values, Unset and Mixed. Use an ON_ModelComponentTypeIterator instance to iterate over the ON_ModelComponent::Type values. 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_HistoryRecord () ON_NOEXCEPT
 
 ON_HistoryRecord (const ON_HistoryRecord &src)
 
 ~ON_HistoryRecord ()
 
bool CopyOnReplaceObject () const
 
void DestroyValue (int value_id)
 
void Dump (ON_TextLog &) const override
 Creates a text dump of the object. More...
 
bool GetBoolValue (int value_id, bool *b) const
 
int GetBoolValues (int value_id, ON_SimpleArray< bool > &) const
 
bool GetBrepValue (int value_id, const ON_Brep *&) const
 
bool GetColorValue (int value_id, ON_Color *color) const
 
int GetColorValues (int value_id, ON_SimpleArray< ON_Color > &) const
 
bool GetCurveValue (int value_id, const ON_Curve *&) const
 
bool GetDoubleValue (int value_id, double *number) const
 
int GetDoubleValues (int value_id, ON_SimpleArray< double > &) const
 
bool GetGeometryValue (int value_id, const ON_Geometry *&) const
 
int GetGeometryValues (int value_id, ON_SimpleArray< const ON_Geometry *> &) const
 
bool GetIntValue (int value_id, int *i) const
 
int GetIntValues (int value_id, ON_SimpleArray< int > &) const
 
bool GetMeshValue (int value_id, const ON_Mesh *&) const
 
bool GetObjRefValue (int value_id, ON_ObjRef &oref) const
 
int GetObjRefValues (int value_id, ON_ClassArray< ON_ObjRef > &objects) const
 
bool GetPointOnObjectValue (int value_id, ON_ObjRef &oref) const
 
bool GetPointValue (int value_id, ON_3dPoint &point) const
 
int GetPointValues (int value_id, ON_SimpleArray< ON_3dPoint > &) const
 
bool GetPolyEdgeValue (int value_id, const ON_PolyEdgeHistory *&polyedge) const
 
int GetPolyEdgeValues (int value_id, ON_SimpleArray< const ON_PolyEdgeHistory *> &) const
 
bool GetStringValue (int value_id, ON_wString &str) const
 For retrieving values. More...
 
int GetStringValues (int value_id, ON_ClassArray< ON_wString > &string) const
 
bool GetSurfaceValue (int value_id, const ON_Surface *&) const
 
bool GetUuidValue (int value_id, ON_UUID *uuid) const
 
int GetUuidValues (int value_id, ON_SimpleArray< ON_UUID > &) const
 
bool GetVectorValue (int value_id, ON_3dVector &point) const
 
int GetVectorValues (int value_id, ON_SimpleArray< ON_3dVector > &) const
 
bool GetXformValue (int value_id, ON_Xform &point) const
 
int GetXformValues (int value_id, ON_SimpleArray< ON_Xform > &) const
 
bool IsAntecedent (ON_UUID object_uuid) 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_HistoryRecordoperator= (const ON_HistoryRecord &src)
 
bool Read (ON_BinaryArchive &binary_archive) override
 Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...
 
void RemapObjectIds (const ON_SimpleArray< ON_UuidPair > &uuid_remap)
 This tool is used in rare situations when the object ids stored in the uuid list need to be remapped. More...
 
bool SetBoolValue (int value_id, bool b)
 For setting values. More...
 
bool SetBoolValues (int value_id, int count, const bool *b)
 For setting values. More...
 
bool SetColorValue (int value_id, ON_Color c)
 
bool SetColorValues (int value_id, int count, const ON_Color *c)
 
void SetCopyOnReplaceObject (bool bCopyOnReplaceObject)
 
bool SetDoubleValue (int value_id, double x)
 
bool SetDoubleValues (int value_id, int count, const double *x)
 
bool SetGeometryValue (int value_id, ON_Geometry *g)
 
bool SetGeometryValues (int value_id, const ON_SimpleArray< ON_Geometry *> a)
 
bool SetIntValue (int value_id, int i)
 
bool SetIntValues (int value_id, int count, const int *i)
 
bool SetObjRefValue (int value_id, const ON_ObjRef &oref)
 
bool SetObjRefValues (int value_id, int count, const ON_ObjRef *oref)
 
bool SetPointOnObjectValue (int value_id, const ON_ObjRef &oref, ON_3dPoint point)
 
bool SetPointValue (int value_id, ON_3dPoint p)
 
bool SetPointValues (int value_id, int count, const ON_3dPoint *P)
 
bool SetPolyEdgeValue (int value_id, const ON_PolyEdgeHistory &polyedge)
 
bool SetPolyEdgeValues (int value_id, int count, const ON_PolyEdgeHistory *a)
 
bool SetStringValue (int value_id, const wchar_t *s)
 
bool SetStringValues (int value_id, int count, const wchar_t *const *s)
 
bool SetStringValues (int value_id, const ON_ClassArray< ON_wString > &s)
 
bool SetUuidValue (int value_id, ON_UUID uuid)
 
bool SetUuidValues (int value_id, int count, const ON_UUID *u)
 
bool SetVectorValue (int value_id, ON_3dVector v)
 
bool SetVectorValues (int value_id, int count, const ON_3dVector *V)
 
bool SetXformValue (int value_id, ON_Xform xform)
 
bool SetXformValues (int value_id, int count, const ON_Xform *xform)
 
int ValueReport (ON_TextLog &text_log) const
 Print a list of the values in text_log. More...
 
bool Write (ON_BinaryArchive &binary_archive) const override
 Low level archive writing tool used by ON_BinaryArchive::WriteObject(). More...
 
- Public Member Functions inherited from ON_ModelComponent
 ON_ModelComponent () ON_NOEXCEPT
 
 ON_ModelComponent (const ON_ModelComponent &source)
 
 ON_ModelComponent (ON_ModelComponent::Type component_type) ON_NOEXCEPT
 Sets and locks the component type attribute. More...
 
 ON_ModelComponent (ON_ModelComponent::Type component_type, const ON_ModelComponent &source) ON_NOEXCEPT
 Locked status of source attributes is not copied to permit copy and modify operations. More...
 
 ~ON_ModelComponent ()=default
 
bool ChangeName (const wchar_t *new_name, class ON_ComponentManifest *manifest)
 Change the name of a component and optionally update a manifest. More...
 
bool ClearComponentType ()
 Set the model serial number value to the ON_ModelComponent::Unset.Type() and change the state so TypeIsSet() returns false. More...
 
bool ClearId ()
 Set the component id value to the ON_ModelComponent::Unset.ModelComponentId() and change the state so ModelComponentIdIsSet() returns false. More...
 
bool ClearIndex ()
 Set the component index value to the ON_ModelComponent::Unset.ModelComponentIndex() and change the state so ModelComponentIndexIsSet() returns false. More...
 
unsigned int ClearModelComponentAttributes (unsigned int attributes_filter)
 Writes the attributes identified by the component_filter parameter. More...
 
bool ClearModelComponentStatus ()
 
bool ClearModelSerialNumber ()
 Sets the model serial number, reference model serial number and instance definition model serial number values to 0 and flags these values as unset. More...
 
bool ClearName ()
 Set the component name value to the ON_ModelComponent::Unset.Name() and change the state so NameIsSet() and DeletedNameIsSet() both return false. More...
 
bool ClearParentId ()
 
int CompareName (const ON_UUID &other_parent_id, const wchar_t *other_name) const
 
int CompareName (const wchar_t *other_name) const
 
int CompareNameExact (const ON_UUID &other_parent_id, const wchar_t *other_name) const
 
int CompareNameExact (const wchar_t *other_name) const
 
ON_ModelComponent::Type ComponentType () const
 
bool ComponentTypeIsLocked () const
 
bool ComponentTypeIsSet () const
 
ON__UINT64 ContentVersionNumber () const
 Whenever an attribute is changed, the content version number is incremented. The ContentVersionNumber() is commonly used by consumers of the model component attributes to trigger updates when needed. More...
 
unsigned int CopyFrom (const ON_ModelComponent &src, unsigned int attributes_filter)
 
ON__UINT32 DataCRC (ON__UINT32 current_remainder) const override
 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...
 
const ON_wString DeletedName () const
 
const ON_NameHashDeletedNameHash () const
 
bool DeletedNameIsSet () const
 
bool DeleteName ()
 If NameIsSet() is true, then the name is deleted in a waty that can be undone by calling UndeleteName() and the DeletedNameIsSet() property is changed to true. More...
 
bool EraseIdentification (bool bIgnoreLocks)
 
const wchar_tGetName (ON_wString &component_name) const
 
const ON_UUIDId () const
 
bool IdIsLocked () const
 
bool IdIsNil () const
 
bool IdIsNotNil () const
 
bool IdIsSet () const
 
const ON_UUIDIfIdIsNilSetId ()
 If the it is nil, call SetId(). More...
 
int Index () const
 
int Index (int unset_index_value) const
 
bool IndexIsLocked () const
 
bool IndexIsSet () const
 
unsigned int InstanceDefinitionModelSerialNumber () const
 
bool IsDeleted () const
 
bool IsHidden () const
 
bool IsLocked () const
 
bool IsReferenceComponent () const
 
bool IsSystemComponent () const
 
void LockAllSettingsExceptName ()
 
void LockComponentType ()
 Calling LockType() will prhibit future changes to the Type attribute. More...
 
void LockId ()
 Calling LockModelComponentId() will prhibit future changes to the ModelComponentId attribute. More...
 
void LockIndex ()
 Calling LockModelComponentIndex() will prhibit future changes to the ModelComponentIndex attribute. More...
 
void LockModelComponentStatus ()
 
void LockModelSerialNumber ()
 Calling LockModelSerialNumber() will prohibit future changes to the ModelSerialNumber(), ReferenceModelSerialNumber(), and InstanceDefinitionModelSerialNumber() attributes. More...
 
void LockName ()
 Calling LockName() will prohibit future changes to the Name attribute. More...
 
void LockParentId ()
 
ON_ComponentStatus ModelComponentStatus () const
 
bool ModelComponentStatusIsLocked () const
 
bool ModelComponentStatusIsSet () const
 
ON_UUID ModelObjectId () const override
 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 ModelSerialNumber () const
 
bool ModelSerialNumberIsLocked () const
 
bool ModelSerialNumberIsSet () const
 
const ON_wString Name () const
 
const wchar_tNameAsPointer () const
 Expert user function that gets a pointer to the name. More...
 
const ON_NameHashNameHash () const
 Get a platform independent hash of the name suitable for equality testing and binary searching. When testing for equality or doing binary searches, using ON_NameHash values is faster than using the CompareName or ON_wString::CompareAttributeName. More...
 
bool NameIsEmpty () const
 
bool NameIsLocked () const
 
bool NameIsNotEmpty () const
 
bool NameIsSet () const
 
const ON_NameHash NewNameHash (const wchar_t *new_name) const
 
ON_ModelComponentoperator= (const ON_ModelComponent &source)
 
const ON_UUIDParentId () const
 
bool ParentIdIsLocked () const
 
bool ParentIdIsNil () const
 
bool ParentIdIsNotNil () const
 
bool ParentIdIsSet () const
 
bool ReadModelComponentAttributes (class ON_BinaryArchive &archive)
 
unsigned int ReferenceModelSerialNumber () const
 
ON__UINT64 RuntimeSerialNumber () const
 
const ON_UUIDSetAndLockId ()
 Sets the id to a new value created by ON_CreateUuid() and locks the id attribute so it cannot be changed. More...
 
bool SetAsSystemComponent ()
 
bool SetAsUnsetSystemComponent ()
 
bool SetComponentType (ON_ModelComponent::Type component_component_type)
 
bool SetDeletedModelComponentState (bool bDeleted, class ON_ComponentManifest *manifest)
 
void SetHiddenModelComponentState (bool bHidden)
 
bool SetId (const ON_UUID &component_id)
 
const ON_UUIDSetId ()
 Sets the id to a new value created by ON_CreateUuid(). More...
 
bool SetIdentification (const class ON_ComponentManifestItem &manifest_item, const wchar_t *manifest_name, bool bSetId, bool bParentId, bool bSetName, bool bSetIndex)
 Set a component's id, name and index to the manifest_item values. More...
 
bool SetIndex (int component_index)
 
bool SetLocalizedSystemComponentName (const wchar_t *system_component_localized_name)
 
void SetLockedModelComponentState (bool bLocked)
 
bool SetModelComponentStatus (ON_ComponentStatus component_status)
 
bool SetModelSerialNumber (unsigned int model_serial_number)
 Specify the model that is managing this component. More...
 
bool SetModelSerialNumber (unsigned int model_serial_number, unsigned int reference_model_serial_number, unsigned int instance_definition_model_serial_number)
 Specify the model that is managing this component. More...
 
bool SetName (const wchar_t *component_name)
 
bool SetParentId (const ON_UUID &parent_id)
 
unsigned int SizeOf () const override
 
bool UndeleteName ()
 
bool WriteModelComponentAttributes (class ON_BinaryArchive &archive, unsigned int attributes_filter) const
 
- 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...
 
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_UserDataFirstUserData () 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_UserDataGetUserData (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...
 
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...
 
virtual ON::object_type ObjectType () const
 Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. More...
 
ON_Objectoperator= (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
 

Static Public Member Functions

static ON_HistoryRecord::RECORD_TYPE RecordType (int i)
 Convert integer into an ON_HistoryRecord::RECORD_TYPE. More...
 
- Static Public Member Functions inherited from ON_ModelComponent
static int CompareId (const ON_ModelComponent &a, const ON_ModelComponent &b)
 
static int CompareIdAndName (const ON_ModelComponent &a, const ON_ModelComponent &b)
 
static int CompareName (const ON_ModelComponent &a, const ON_ModelComponent &b)
 
static int CompareNameAndId (const ON_ModelComponent &a, const ON_ModelComponent &b)
 
static int CompareNameExact (const ON_ModelComponent &a, const ON_ModelComponent &b)
 
static ON_ModelComponent::Type ComponentTypeFromUnsigned (unsigned int component_type_as_unsigned)
 
static bool ComponentTypeIsValid (ON_ModelComponent::Type component_type)
 
static bool ComponentTypeIsValidAndNotMixed (ON_ModelComponent::Type component_type)
 
static const ON_wString ComponentTypeToString (ON_ModelComponent::Type)
 
static bool IndexRequired (ON_ModelComponent::Type component_type)
 
static unsigned int Internal_SystemComponentHelper ()
 For internal use. Never call this function. More...
 
static const wchar_tIsNamePathSeparator (const wchar_t *s)
 Test a string to see if its beginning matches the string returned by ON_ModelComponent::NamePathSeparator. More...
 
*</code > *</example > *static const wchar_tIsReferencePrefixDelimiter (const wchar_t *s)
 Test a string to see if its beginning matches the string returned by ON_ModelComponent::NameReferenceDelimiter. More...
 
static const wchar_tIsReferencePrefixSeparator (const wchar_t *s)
 Test a string to see if its beginning matches the string returned by ON_ModelComponent::NameReferenceSeparator. More...
 
static bool IsValidComponentName (const wchar_t *candidate_component_name)
 
static bool IsValidComponentName (const ON_wString &candidate_component_name)
 
static bool IsValidComponentName (size_t length, const wchar_t *candidate_component_name)
 
static bool IsValidComponentName (const class ON_ComponentManifest &model_manfest, const ON_ModelComponent &model_component, bool bPermitReferencePrefix, ON_wString &valid_name)
 
static bool IsValidComponentNameFirstCodePoint (ON__UINT32 unicode_code_point)
 
static bool IsValidComponentNameFirstCodePoint (int length, const wchar_t *candidate_component_name)
 
static const ON_wString NameLeaf (const wchar_t *name)
 
static const ON_wString NameParent (const wchar_t *name, bool bIncludeReference)
 
static const ON_wString NameReferencePrefix (const wchar_t *name)
 
static const ON_wString RemoveAllReferencePrefixDelimiters (const wchar_t *name)
 Remove all occurances of ON::NameReferenceDelimiter() from name. More...
 
static const ON_wString RemoveReferencePrefix (const wchar_t *name)
 
static const ON_wString RemoveTrailingNamePathSeparator (const wchar_t *name)
 Remove any trailing occurance of ON_ModelComponent::NamePathSeparator from name. More...
 
static const ON_wString RemoveTrailingReferencePrefixDelimiter (const wchar_t *name)
 Remove any trailing occurance of ON_ModelComponent::NameReferenceDelimiter from name. More...
 
static const ON_wString RemoveTrailingReferencePrefixSeparator (const wchar_t *name)
 Remove any trailing occurance of ON_ModelComponent::NameReferenceSeparator from name. More...
 
static void SplitName (const wchar_t *name, ON_wString &reference_prefix, ON_wString &name_parent, ON_wString &name_leaf)
 
static bool UniqueNameIgnoresCase (ON_ModelComponent::Type component_type)
 
static bool UniqueNameIncludesParent (ON_ModelComponent::Type component_type)
 
static bool UniqueNameRequired (ON_ModelComponent::Type component_type)
 

Public Attributes

ON_UuidList m_antecedents
 
ON_UUID m_command_id = ON_nil_uuid
 
ON_UuidList m_descendants
 
RECORD_TYPE m_record_type = ON_HistoryRecord::RECORD_TYPE::history_parameters
 
ON_SimpleArray< class ON_Value *> m_value
 
int m_version = 0
 

Static Public Attributes

static const ON_HistoryRecord Empty
 
- Static Public Attributes inherited from ON_ModelComponent
static const ON_wString NamePathSeparator
 Returns the string "::". This is the string Rhino uses in layer full path names to separate the names of individual layers. More...
 
static const ON_wString ReferencePrefixDelimiter
 Returns the string " : ". This is the string Rhino uses to separate the reference file names from and model component names read from those files. More...
 
static const ON_wString ReferencePrefixSeparator
 Returns the string ">". This is the string Rhino uses to separate the block definition name and linked file name in grandparent layers. More...
 
static const ON_ModelComponent Unset
 
*static const ON_wString WorksessionReferencePrefix *const wchar_t
 

Additional Inherited Members

- Protected Member Functions inherited from ON_ModelComponent
void IncrementContentVersionNumber () const
 

Member Enumeration Documentation

◆ RECORD_TYPE

enum ON_HistoryRecord::RECORD_TYPE : unsigned int
strong
Enumerator
history_parameters 
feature_parameters 

Constructor & Destructor Documentation

◆ ON_HistoryRecord() [1/2]

ON_HistoryRecord::ON_HistoryRecord ( )

◆ ~ON_HistoryRecord()

ON_HistoryRecord::~ON_HistoryRecord ( )

◆ ON_HistoryRecord() [2/2]

ON_HistoryRecord::ON_HistoryRecord ( const ON_HistoryRecord src)

Member Function Documentation

◆ CopyOnReplaceObject()

bool ON_HistoryRecord::CopyOnReplaceObject ( ) const

◆ DestroyValue()

void ON_HistoryRecord::DestroyValue ( int  value_id)

◆ Dump()

void ON_HistoryRecord::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_ModelComponent.

◆ GetBoolValue()

bool ON_HistoryRecord::GetBoolValue ( int  value_id,
bool *  b 
) const

◆ GetBoolValues()

int ON_HistoryRecord::GetBoolValues ( int  value_id,
ON_SimpleArray< bool > &   
) const

◆ GetBrepValue()

bool ON_HistoryRecord::GetBrepValue ( int  value_id,
const ON_Brep *&   
) const

◆ GetColorValue()

bool ON_HistoryRecord::GetColorValue ( int  value_id,
ON_Color color 
) const

◆ GetColorValues()

int ON_HistoryRecord::GetColorValues ( int  value_id,
ON_SimpleArray< ON_Color > &   
) const

◆ GetCurveValue()

bool ON_HistoryRecord::GetCurveValue ( int  value_id,
const ON_Curve *&   
) const

◆ GetDoubleValue()

bool ON_HistoryRecord::GetDoubleValue ( int  value_id,
double *  number 
) const

◆ GetDoubleValues()

int ON_HistoryRecord::GetDoubleValues ( int  value_id,
ON_SimpleArray< double > &   
) const

◆ GetGeometryValue()

bool ON_HistoryRecord::GetGeometryValue ( int  value_id,
const ON_Geometry *&   
) const

◆ GetGeometryValues()

int ON_HistoryRecord::GetGeometryValues ( int  value_id,
ON_SimpleArray< const ON_Geometry *> &   
) const

◆ GetIntValue()

bool ON_HistoryRecord::GetIntValue ( int  value_id,
int *  i 
) const

◆ GetIntValues()

int ON_HistoryRecord::GetIntValues ( int  value_id,
ON_SimpleArray< int > &   
) const

◆ GetMeshValue()

bool ON_HistoryRecord::GetMeshValue ( int  value_id,
const ON_Mesh *&   
) const

◆ GetObjRefValue()

bool ON_HistoryRecord::GetObjRefValue ( int  value_id,
ON_ObjRef oref 
) const

◆ GetObjRefValues()

int ON_HistoryRecord::GetObjRefValues ( int  value_id,
ON_ClassArray< ON_ObjRef > &  objects 
) const

◆ GetPointOnObjectValue()

bool ON_HistoryRecord::GetPointOnObjectValue ( int  value_id,
ON_ObjRef oref 
) const

◆ GetPointValue()

bool ON_HistoryRecord::GetPointValue ( int  value_id,
ON_3dPoint point 
) const

◆ GetPointValues()

int ON_HistoryRecord::GetPointValues ( int  value_id,
ON_SimpleArray< ON_3dPoint > &   
) const

◆ GetPolyEdgeValue()

bool ON_HistoryRecord::GetPolyEdgeValue ( int  value_id,
const ON_PolyEdgeHistory *&  polyedge 
) const

◆ GetPolyEdgeValues()

int ON_HistoryRecord::GetPolyEdgeValues ( int  value_id,
ON_SimpleArray< const ON_PolyEdgeHistory *> &   
) const

◆ GetStringValue()

bool ON_HistoryRecord::GetStringValue ( int  value_id,
ON_wString str 
) const

For retrieving values.

◆ GetStringValues()

int ON_HistoryRecord::GetStringValues ( int  value_id,
ON_ClassArray< ON_wString > &  string 
) const

◆ GetSurfaceValue()

bool ON_HistoryRecord::GetSurfaceValue ( int  value_id,
const ON_Surface *&   
) const

◆ GetUuidValue()

bool ON_HistoryRecord::GetUuidValue ( int  value_id,
ON_UUID uuid 
) const

◆ GetUuidValues()

int ON_HistoryRecord::GetUuidValues ( int  value_id,
ON_SimpleArray< ON_UUID > &   
) const

◆ GetVectorValue()

bool ON_HistoryRecord::GetVectorValue ( int  value_id,
ON_3dVector point 
) const

◆ GetVectorValues()

int ON_HistoryRecord::GetVectorValues ( int  value_id,
ON_SimpleArray< ON_3dVector > &   
) const

◆ GetXformValue()

bool ON_HistoryRecord::GetXformValue ( int  value_id,
ON_Xform point 
) const

◆ GetXformValues()

int ON_HistoryRecord::GetXformValues ( int  value_id,
ON_SimpleArray< ON_Xform > &   
) const

◆ IsAntecedent()

bool ON_HistoryRecord::IsAntecedent ( ON_UUID  object_uuid) const
Parameters
object_uuid[in]
Returns
Returns true if object_uuid is the id of an input object.

◆ IsValid()

bool ON_HistoryRecord::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
lowlevel 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_ModelComponent.

◆ operator=()

ON_HistoryRecord& ON_HistoryRecord::operator= ( const ON_HistoryRecord src)

◆ Read()

bool ON_HistoryRecord::Read ( ON_BinaryArchive binary_archive)
overridevirtual

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

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

◆ RecordType()

static ON_HistoryRecord::RECORD_TYPE ON_HistoryRecord::RecordType ( int  i)
static

Convert integer into an ON_HistoryRecord::RECORD_TYPE.

Parameters
i[in]
Returns
ON_HistoryRecord::RECORD_TYPE enum with same value as i.

◆ RemapObjectIds()

void ON_HistoryRecord::RemapObjectIds ( const ON_SimpleArray< ON_UuidPair > &  uuid_remap)

This tool is used in rare situations when the object ids stored in the uuid list need to be remapped.

Parameters
uuid_remap[in] Is it critical that uuid_remap[] be sorted with respect to ON_UuidPair::CompareFirstUuid.

◆ SetBoolValue()

bool ON_HistoryRecord::SetBoolValue ( int  value_id,
bool  b 
)

For setting values.

Parameters
value_id[in] If there a value with the same input id exists, the old value is replaced.
count[in] Number of values
b[in] array of count bools
i[in] array of count ints
x[in] array of count doubles
p[in] array of count 3d points
v[in] array of count 3d vectors
xform[in] array of count xforms
c[in] array of count colors
or[in] array of count object references
g[in] array of count geometry pointers
u[in] array of uuids
s[in] string

◆ SetBoolValues()

bool ON_HistoryRecord::SetBoolValues ( int  value_id,
int  count,
const bool *  b 
)

For setting values.

Parameters
value_id[in] If there a value with the same input id exists, the old value is replaced.
count[in] Number of values
b[in] array of count bools
i[in] array of count ints
x[in] array of count doubles
P[in] array of count 3d points
V[in] array of count 3d vectors
xform[in] array of count xforms
c[in] array of count colors
or[in] array of count object references
g[in] array of count geometry pointers
u[in] array of uuids
s[in] array of strings

◆ SetColorValue()

bool ON_HistoryRecord::SetColorValue ( int  value_id,
ON_Color  c 
)

◆ SetColorValues()

bool ON_HistoryRecord::SetColorValues ( int  value_id,
int  count,
const ON_Color c 
)

◆ SetCopyOnReplaceObject()

void ON_HistoryRecord::SetCopyOnReplaceObject ( bool  bCopyOnReplaceObject)

◆ SetDoubleValue()

bool ON_HistoryRecord::SetDoubleValue ( int  value_id,
double  x 
)

◆ SetDoubleValues()

bool ON_HistoryRecord::SetDoubleValues ( int  value_id,
int  count,
const double *  x 
)

◆ SetGeometryValue()

bool ON_HistoryRecord::SetGeometryValue ( int  value_id,
ON_Geometry g 
)

◆ SetGeometryValues()

bool ON_HistoryRecord::SetGeometryValues ( int  value_id,
const ON_SimpleArray< ON_Geometry *>  a 
)

◆ SetIntValue()

bool ON_HistoryRecord::SetIntValue ( int  value_id,
int  i 
)

◆ SetIntValues()

bool ON_HistoryRecord::SetIntValues ( int  value_id,
int  count,
const int *  i 
)

◆ SetObjRefValue()

bool ON_HistoryRecord::SetObjRefValue ( int  value_id,
const ON_ObjRef oref 
)

◆ SetObjRefValues()

bool ON_HistoryRecord::SetObjRefValues ( int  value_id,
int  count,
const ON_ObjRef oref 
)

◆ SetPointOnObjectValue()

bool ON_HistoryRecord::SetPointOnObjectValue ( int  value_id,
const ON_ObjRef oref,
ON_3dPoint  point 
)

◆ SetPointValue()

bool ON_HistoryRecord::SetPointValue ( int  value_id,
ON_3dPoint  p 
)

◆ SetPointValues()

bool ON_HistoryRecord::SetPointValues ( int  value_id,
int  count,
const ON_3dPoint P 
)

◆ SetPolyEdgeValue()

bool ON_HistoryRecord::SetPolyEdgeValue ( int  value_id,
const ON_PolyEdgeHistory polyedge 
)

◆ SetPolyEdgeValues()

bool ON_HistoryRecord::SetPolyEdgeValues ( int  value_id,
int  count,
const ON_PolyEdgeHistory a 
)

◆ SetStringValue()

bool ON_HistoryRecord::SetStringValue ( int  value_id,
const wchar_t s 
)

◆ SetStringValues() [1/2]

bool ON_HistoryRecord::SetStringValues ( int  value_id,
int  count,
const wchar_t *const *  s 
)

◆ SetStringValues() [2/2]

bool ON_HistoryRecord::SetStringValues ( int  value_id,
const ON_ClassArray< ON_wString > &  s 
)

◆ SetUuidValue()

bool ON_HistoryRecord::SetUuidValue ( int  value_id,
ON_UUID  uuid 
)

◆ SetUuidValues()

bool ON_HistoryRecord::SetUuidValues ( int  value_id,
int  count,
const ON_UUID u 
)

◆ SetVectorValue()

bool ON_HistoryRecord::SetVectorValue ( int  value_id,
ON_3dVector  v 
)

◆ SetVectorValues()

bool ON_HistoryRecord::SetVectorValues ( int  value_id,
int  count,
const ON_3dVector V 
)

◆ SetXformValue()

bool ON_HistoryRecord::SetXformValue ( int  value_id,
ON_Xform  xform 
)

◆ SetXformValues()

bool ON_HistoryRecord::SetXformValues ( int  value_id,
int  count,
const ON_Xform xform 
)

◆ ValueReport()

int ON_HistoryRecord::ValueReport ( ON_TextLog text_log) const

Print a list of the values in text_log.

Parameters
text_log[in]
Returns
Number of values listed.

◆ Write()

bool ON_HistoryRecord::Write ( ON_BinaryArchive binary_archive) const
overridevirtual

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

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

Member Data Documentation

◆ Empty

const ON_HistoryRecord ON_HistoryRecord::Empty
static

◆ m_antecedents

ON_UuidList ON_HistoryRecord::m_antecedents

◆ m_command_id

ON_UUID ON_HistoryRecord::m_command_id = ON_nil_uuid

◆ m_descendants

ON_UuidList ON_HistoryRecord::m_descendants

◆ m_record_type

◆ m_value

ON_SimpleArray< class ON_Value* > ON_HistoryRecord::m_value

◆ m_version

int ON_HistoryRecord::m_version = 0