Rhino C++ API  7.22
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
CRhinoLinetype Class Reference

#include <rhinoSdkLinetype.h>

Inheritance diagram for CRhinoLinetype:
ON_Linetype ON_ModelComponent ON_Object

Public Member Functions

void DrawLinetype (HDC pDC, const ON_4iRect &rect, COLORREF bkColor, COLORREF fgColor) const
 Draw a few repeats of the linetype into a rectangle. More...
bool IsDeleted () const
bool IsModified () const
bool LinetypePatternIsCurrent (ON__UINT64 &linetype_pattern_id) const
- Public Member Functions inherited from ON_Linetype
 ON_Linetype () ON_NOEXCEPT
 ON_Linetype (const ON_Linetype &)
 ~ON_Linetype ()=default
int AppendSegment (const ON_LinetypeSegment &segment)
bool ClearPattern ()
void Dump (ON_TextLog &) const override
 for debugging More...
ON_SimpleArray< ON_LinetypeSegment > * ExpertSegments ()
 Returns nullptr if the line pattern is locked. More...
bool IsValid (class ON_TextLog *text_log=nullptr) const override
void LockPattern ()
ON_Linetypeoperator= (const ON_Linetype &)=default
bool PatternIsLocked () const
bool PatternIsSet () const
double PatternLength () const
bool Read (ON_BinaryArchive &) override
bool RemoveSegment (int index)
ON_LinetypeSegment Segment (int index) const
int SegmentCount () const
const ON_SimpleArray< ON_LinetypeSegment > & Segments () const
bool SetSegment (int index, const ON_LinetypeSegment &segment)
bool SetSegment (int index, double length, ON_LinetypeSegment::eSegType type)
bool SetSegments (const ON_SimpleArray< ON_LinetypeSegment > &segments)
bool Write (ON_BinaryArchive &) const override
- 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
 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)
bool ClearComponentType ()
bool ClearId ()
bool ClearIndex ()
unsigned int ClearModelComponentAttributes (unsigned int attributes_filter)
bool ClearModelComponentStatus ()
bool ClearModelSerialNumber ()
bool ClearName ()
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
unsigned int CopyFrom (const ON_ModelComponent &src, unsigned int attributes_filter)
ON__UINT32 DataCRC (ON__UINT32 current_remainder) const override
const ON_wString DeletedName () const
const ON_NameHashDeletedNameHash () const
bool DeletedNameIsSet () const
bool DeleteName ()
void Dump (ON_TextLog &) const override
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 ()
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
bool IsValid (class ON_TextLog *text_log=nullptr) const override
void LockAllSettingsExceptName ()
void LockComponentType ()
void LockId ()
void LockIndex ()
void LockModelComponentStatus ()
void LockModelSerialNumber ()
void LockName ()
void LockParentId ()
ON_ComponentStatus ModelComponentStatus () const
bool ModelComponentStatusIsLocked () const
bool ModelComponentStatusIsSet () const
ON_UUID ModelObjectId () const override
unsigned int ModelSerialNumber () const
bool ModelSerialNumberIsLocked () const
bool ModelSerialNumberIsSet () const
const ON_wString Name () const
const wchar_tNameAsPointer () const
const ON_NameHashNameHash () const
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 ()
bool SetAsSystemComponent ()
bool SetAsUnsetSystemComponent ()
bool SetComponentType (ON_ModelComponent::Type component_component_type)
bool SetDeletedModelComponentState (bool bDeleted, class ON_ComponentManifest *manifest)
void SetHiddenModelComponentState (bool bHidden)
const ON_UUIDSetId ()
bool SetId (const ON_UUID &component_id)
bool SetIdentification (const class ON_ComponentManifestItem &manifest_item, const wchar_t *manifest_name, bool bSetId, bool bParentId, bool bSetName, bool bSetIndex)
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)
bool SetModelSerialNumber (unsigned int model_serial_number, unsigned int reference_model_serial_number, unsigned int instance_definition_model_serial_number)
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 (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 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 ()
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 unsigned int NextRuntimeSerialNumber ()
- Static Public Member Functions inherited from ON_Linetype
static const ON_LinetypeFromModelComponentRef (const class ON_ModelComponentReference &model_component_reference, const ON_Linetype *none_return_value)
- 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)
*static const wchar_tIsReferencePrefixDelimiter (const wchar_t *s)
static const wchar_tIsReferencePrefixSeparator (const wchar_t *s)
static bool IsValidComponentName (const class ON_ComponentManifest &model_manfest, const ON_ModelComponent &model_component, bool bPermitReferencePrefix, ON_wString &valid_name)
static bool IsValidComponentName (const ON_wString &candidate_component_name)
static bool IsValidComponentName (const wchar_t *candidate_component_name)
static bool IsValidComponentName (size_t length, const wchar_t *candidate_component_name)
static bool IsValidComponentNameFirstCodePoint (int length, const wchar_t *candidate_component_name)
static bool IsValidComponentNameFirstCodePoint (ON__UINT32 unicode_code_point)
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 ON__UINT64 NextRuntimeSerialNumber ()
static const ON_wString RemoveAllReferencePrefixDelimiters (const wchar_t *name)
static const ON_wString RemoveReferencePrefix (const wchar_t *name)
static const ON_wString RemoveTrailingNamePathSeparator (const wchar_t *name)
static const ON_wString RemoveTrailingReferencePrefixDelimiter (const wchar_t *name)
static const ON_wString RemoveTrailingReferencePrefixSeparator (const wchar_t *name)
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

int m_display_segs_sn
const class CRhinoLinetypeTablem_doc_linetype_table
const int m_linetype_sn
int m_remap_index = -1
 Runtime index used when remapping linetypes for import/export. More...
int m_sort_index = -1
 Runtime index used to sort linetypes in linetype dialog. More...


class CRhinoLinetypeTable

Additional Inherited Members

- 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. /summary> 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
- Static Public Attributes inherited from ON_Linetype
static const ON_Linetype Border
 index = -8, id, name and pattern are set. More...
static const ON_Linetype ByLayer
 index = -2, id, name and pattern are set. More...
static const ON_Linetype ByParent
 index = -3, id, name and pattern are set. More...
static const ON_Linetype Center
 index = -7, id, name and pattern are set. More...
static const ON_Linetype Continuous
 index = -1, id, name and pattern are set. More...
static const ON_Linetype DashDot
 index = -6, id, name and pattern are set. More...
static const ON_Linetype Dashed
 index = -5, id, name and pattern are set. More...
static const ON_Linetype Dots
 index = -9, id, name and pattern are set. More...
static const ON_Linetype Hidden
 index = -4, id, name and pattern are set. More...
static const ON_Linetype Unset
 no attributes are set. More...
- Static Public Attributes inherited from ON_ModelComponent
static const ON_wString NamePathSeparator
static const ON_wString ReferencePrefixDelimiter
static const ON_wString ReferencePrefixSeparator
static const ON_ModelComponent Unset
*static const ON_wString WorksessionReferencePrefix *const wchar_t
- Protected Member Functions inherited from ON_ModelComponent
void IncrementContentVersionNumber () const

Detailed Description

Copyright (c) 1993-2017 Robert McNeel & Associates. All rights reserved. Rhinoceros is a registered trademark of Robert McNeel & Associates.


For complete Rhino SDK copyright information see http://www.rhino3d.com/developer.

Member Function Documentation

◆ DrawLinetype()

void CRhinoLinetype::DrawLinetype ( HDC  pDC,
const ON_4iRect rect,
COLORREF  bkColor,
COLORREF  fgColor 
) const

Draw a few repeats of the linetype into a rectangle.

◆ IsDeleted()

bool CRhinoLinetype::IsDeleted ( ) const

Description: Deleted linetypes are kept in the runtime linetype table so that undo will work with linetypes. Call IsDeleted() to determine if a linetype is deleted.

Returns: true if linetype is deleted.

◆ IsModified()

bool CRhinoLinetype::IsModified ( ) const

Description: Rhino provides the ability to undo linetype modifications.

Returns: true if this linetype has been modified by CRhinoLinetypeTable::ModifyLinetype()and the modifications can be undone.

See Also: UndoModify.

◆ LinetypePatternIsCurrent()

bool CRhinoLinetype::LinetypePatternIsCurrent ( ON__UINT64 linetype_pattern_id) const

Description: Call this function to determine if the display segs being used are current. Parameters: linetype_pattern_id - [in/out] Store this value someplace on the object that cares about this linetype's pattern. If this function returns true, the the input and output values are the same. If it returns false, the returned value is different. Returns: true: The linetype's pattern has not changed. False: the linetype's pattern has changed an the display of the object needs to be updated.

◆ NextRuntimeSerialNumber()

static unsigned int CRhinoLinetype::NextRuntimeSerialNumber ( )

Friends And Related Function Documentation

◆ CRhinoLinetypeTable

friend class CRhinoLinetypeTable

Member Data Documentation

◆ m_display_segs_sn

int CRhinoLinetype::m_display_segs_sn

When something in changes that should trigger a recalculation of the information in ON_Linetype.m_segments[], increment m_display_segs_sn.

◆ m_doc_linetype_table

const class CRhinoLinetypeTable& CRhinoLinetype::m_doc_linetype_table

◆ m_linetype_sn

const int CRhinoLinetype::m_linetype_sn

Runtime serial number of this linetype. This serial number is unique for each linetype in an instance of a Rhino application. This serial number is not saved in files and it is generally different the next time a file is read.

◆ m_remap_index

int CRhinoLinetype::m_remap_index = -1

Runtime index used when remapping linetypes for import/export.

◆ m_sort_index

int CRhinoLinetype::m_sort_index = -1

Runtime index used to sort linetypes in linetype dialog.