Rhino C++ API  8.7
Public Member Functions | Static Public Member Functions | List of all members
ON_DisplacementUserData Class Reference

#include <opennurbs_mesh_modifiers.h>

Inheritance diagram for ON_DisplacementUserData:
ON_XMLUserData ON_UserData ON_Object

Public Member Functions

 ON_DisplacementUserData ()
 ON_DisplacementUserData (const ON_DisplacementUserData &ud)
virtual bool GetDescription (ON_wString &s) override
const ON_DisplacementUserDataoperator= (const ON_DisplacementUserData &ud)
virtual bool Read (ON_BinaryArchive &) override
virtual void ReportVersionError (void) const override
virtual void SetToDefaults (void) const override
virtual bool Transform (const ON_Xform &xform) override
- Public Member Functions inherited from ON_XMLUserData
 ON_XMLUserData ()
 ON_XMLUserData (const ON_XMLUserData &ud)
virtual ~ON_XMLUserData ()
virtual void _Dump (const wchar_t *wszFileName) const
virtual bool Archive (void) const override
virtual void Clear (void) const
virtual void * EVF (const wchar_t *func, void *data)
 Emergency virtual function for future expansion. More...
const ON_XMLUserDataoperator= (const ON_XMLUserData &ud)
virtual ON_XMLPropertyProperty (const wchar_t *xml_path, const wchar_t *prop_name) const
virtual void SetToDefaultsImpl (int) const
virtual void SetValue (const wchar_t *xml_path, const ON_XMLVariant &value)
virtual bool SetValue (const wchar_t *xml_path, const wchar_t *prop_name, const ON_XMLVariant &value)
virtual ON_XMLVariant Value (const wchar_t *xml_path, const wchar_t *prop_name=L"") const
virtual int Version (void) const
virtual bool Write (ON_BinaryArchive &) const override
virtual const ON_XMLRootNodeXMLRootForRead (void) const
virtual ON_XMLRootNodeXMLRootForWrite (void) const
- Public Member Functions inherited from ON_UserData
 ON_UserData ()
 ON_UserData (const ON_UserData &)
 ~ON_UserData ()
virtual bool DeleteAfterRead (const class ON_BinaryArchive &archive, class ON_Object *parent_object) const
virtual bool DeleteAfterWrite (const class ON_BinaryArchive &archive, const class ON_Object *parent_object) const
void Dump (ON_TextLog &text_log) const override
bool IsUnknownUserData () const
bool IsValid (class ON_TextLog *text_log=nullptr) const override
ON_UserDataNext () const
ON_UserDataoperator= (const ON_UserData &)
ON_ObjectOwner () const
 Returns object that owns the user data. More...
unsigned int SizeOf () const override
ON_UUID UserDataClassUuid () const
virtual bool WriteToArchive (const class ON_BinaryArchive &archive, const class ON_Object *parent_object) const
- Public Member Functions inherited from ON_Object
 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_UserDataFirstUserData () const
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
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)
virtual ON::object_type ObjectType () const
ON_Objectoperator= (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

Static Public Member Functions

static ON_UUID Uuid (void)

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
- Public Attributes inherited from ON_UserData
ON_UUID m_application_uuid
unsigned int m_userdata_copycount
ON_UUID m_userdata_uuid
ON_Xform m_userdata_xform
- Protected Member Functions inherited from ON_XMLUserData
ON_XMLPropertyInternalProperty (const wchar_t *xml_path, const wchar_t *prop_name) const

Constructor & Destructor Documentation

◆ ON_DisplacementUserData() [1/2]

ON_DisplacementUserData::ON_DisplacementUserData ( )

◆ ON_DisplacementUserData() [2/2]

ON_DisplacementUserData::ON_DisplacementUserData ( const ON_DisplacementUserData ud)

Member Function Documentation

◆ GetDescription()

virtual bool ON_DisplacementUserData::GetDescription ( ON_wString description)

Parameters: description - [out] description of user data shown in object properties dump. Returns: True if user data class is ready.

Reimplemented from ON_UserData.

◆ operator=()

const ON_DisplacementUserData& ON_DisplacementUserData::operator= ( const ON_DisplacementUserData ud)

◆ Read()

virtual bool ON_DisplacementUserData::Read ( ON_BinaryArchive binary_archive)

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

◆ ReportVersionError()

virtual void ON_DisplacementUserData::ReportVersionError ( void  ) const

Implements ON_XMLUserData.

◆ SetToDefaults()

virtual void ON_DisplacementUserData::SetToDefaults ( void  ) const

Implements ON_XMLUserData.

◆ Transform()

virtual bool ON_DisplacementUserData::Transform ( const ON_Xform )

Description: If Transform() return false, then the userdata is destroyed when its parent object is transformed. The default Transform() updates m_userdata_xform and returns true. Carefully read the comments above m_userdata_xform

Reimplemented from ON_UserData.

◆ Uuid()

static ON_UUID ON_DisplacementUserData::Uuid ( void  )