Rhino C++ API  8.8
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
ON_Linetype Class Reference

class ON_Linetype More...

#include <opennurbs_linetype.h>

Inheritance diagram for ON_Linetype:
ON_ModelComponent ON_Object CRhinoLinetype

Public Member Functions

 ON_Linetype () ON_NOEXCEPT
 ON_Linetype (const ON_Linetype &)
 ~ON_Linetype ()
bool AlwaysModelDistances () const
int AppendSegment (const ON_LinetypeSegment &segment)
void ClearBits ()
bool ClearPattern ()
void Dump (ON_TextLog &) const override
 for debugging More...
ON_LinetypeDuplicateLinetype () const
ON_SimpleArray< ON_LinetypeSegment > * ExpertSegments ()
 Returns nullptr if the line pattern is locked. More...
bool IsValid (class ON_TextLog *text_log=nullptr) const override
ON::LineCapStyle LineCapStyle () const
ON::LineJoinStyle LineJoinStyle () const
void LockPattern ()
ON_Linetypeoperator= (const ON_Linetype &)
bool PatternIsLocked () const
bool PatternIsSet () const
double PatternLength () const
bool Read (ON_BinaryArchive &) override
bool RemoveSegment (int index)
void RemoveTaper ()
ON_LinetypeSegment Segment (int index) const
int SegmentCount () const
const ON_SimpleArray< ON_LinetypeSegment > & Segments () const
void SetAlwaysModelDistances (bool on)
void SetLineCapStyle (ON::LineCapStyle style)
void SetLineJoinStyle (ON::LineJoinStyle style)
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 SetTaper (double startWidth, double endWidth)
bool SetTaper (double startWidth, ON_2dPoint taperPoint, double endWidth)
void SetWidth (double width)
void SetWidthUnits (ON::LengthUnitSystem units)
const ON_SimpleArray< ON_2dPoint > * TaperPoints () const
double Width () const
ON::LengthUnitSystem WidthUnits () const
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 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)

Static Public Attributes

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

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::Material = 3,
  Type::RenderMaterial = Material, 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::RenderContent = 14,
  Type::EmbeddedFile = 15, Type::ObsoleteValue = 16, Type::SectionStyle = 17, Type::NumOf,
  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
- Protected Member Functions inherited from ON_ModelComponent
void IncrementContentVersionNumber () const

Detailed Description

class ON_Linetype

Constructor & Destructor Documentation

◆ ON_Linetype() [1/2]

ON_Linetype::ON_Linetype ( )

◆ ~ON_Linetype()

ON_Linetype::~ON_Linetype ( )

◆ ON_Linetype() [2/2]

ON_Linetype::ON_Linetype ( const ON_Linetype )

Member Function Documentation

◆ AlwaysModelDistances()

bool ON_Linetype::AlwaysModelDistances ( ) const

Description: When true, pattern lengths and widths are always in models distances When false (default), lengths and widths are interpreted as lengths and widths on a page layout or in actual output prints

◆ AppendSegment()

int ON_Linetype::AppendSegment ( const ON_LinetypeSegment segment)

Description: Adds a segment to the pattern Returns: Index of the added segment.

◆ ClearBits()

void ON_Linetype::ClearBits ( )

Description: For expert use only.

◆ ClearPattern()

bool ON_Linetype::ClearPattern ( )

◆ Dump()

void ON_Linetype::Dump ( ON_TextLog ) const

for debugging

Reimplemented from ON_Object.

◆ DuplicateLinetype()

ON_Linetype* ON_Linetype::DuplicateLinetype ( ) const

Description: Duplicates this linetype, clears the name, id, and locked bits.

◆ ExpertSegments()

ON_SimpleArray<ON_LinetypeSegment>* ON_Linetype::ExpertSegments ( )

Returns nullptr if the line pattern is locked.

Description: Expert user function to get access to the segment array for rapid calculations.

◆ FromModelComponentRef()

static const ON_Linetype* ON_Linetype::FromModelComponentRef ( const class ON_ModelComponentReference model_component_reference,
const ON_Linetype none_return_value 

Parameters: model_component_reference - [in] none_return_value - [in] value to return if ON_Linetype::Cast(model_component_ref.ModelComponent()) is nullptr Returns: If ON_Linetype::Cast(model_component_ref.ModelComponent()) is not nullptr, that pointer is returned. Otherwise, none_return_value is returned.

◆ IsValid()

bool ON_Linetype::IsValid ( class ON_TextLog text_log = nullptr) const

Description: Tests that name is set and there is at least one non-zero length segment

Reimplemented from ON_Object.

◆ LineCapStyle()

ON::LineCapStyle ON_Linetype::LineCapStyle ( ) const

Description: End cap style used on open curves

◆ LineJoinStyle()

ON::LineJoinStyle ON_Linetype::LineJoinStyle ( ) const

Description: Corner join style for curves

◆ LockPattern()

void ON_Linetype::LockPattern ( )

◆ operator=()

ON_Linetype& ON_Linetype::operator= ( const ON_Linetype )

◆ PatternIsLocked()

bool ON_Linetype::PatternIsLocked ( ) const

◆ PatternIsSet()

bool ON_Linetype::PatternIsSet ( ) const


◆ PatternLength()

double ON_Linetype::PatternLength ( ) const

Description: Returns the total length of one repeat of the pattern

◆ Read()

bool ON_Linetype::Read ( ON_BinaryArchive )

Description: Read from file

Reimplemented from ON_Object.

◆ RemoveSegment()

bool ON_Linetype::RemoveSegment ( int  index)

Description: Removes a segment in the linetype. Parameters: index - [in] Zero based index of the segment to remove. Returns: True if the segment index was removed.

◆ RemoveTaper()

void ON_Linetype::RemoveTaper ( )

Description: Remove taper points from this linetype

◆ Segment()

ON_LinetypeSegment ON_Linetype::Segment ( int  index) const

Description: Returns a copy of the segment at index

◆ SegmentCount()

int ON_Linetype::SegmentCount ( ) const

Description: Returns the number of segments in the pattern

◆ Segments()

const ON_SimpleArray<ON_LinetypeSegment>& ON_Linetype::Segments ( ) const

◆ SetAlwaysModelDistances()

void ON_Linetype::SetAlwaysModelDistances ( bool  on)

Description: Set how lengths and widths are interpreted when displayed in layouts or printed

◆ SetLineCapStyle()

void ON_Linetype::SetLineCapStyle ( ON::LineCapStyle  style)

Description: Set style used for end caps on open curves

◆ SetLineJoinStyle()

void ON_Linetype::SetLineJoinStyle ( ON::LineJoinStyle  style)

Description: Set style used for corners on curves

◆ SetSegment() [1/2]

bool ON_Linetype::SetSegment ( int  index,
const ON_LinetypeSegment segment 

Description: Sets the segment at index to match segment

◆ SetSegment() [2/2]

bool ON_Linetype::SetSegment ( int  index,
double  length,
ON_LinetypeSegment::eSegType  type 

Description: Sets the length and type of the segment at index

◆ SetSegments()

bool ON_Linetype::SetSegments ( const ON_SimpleArray< ON_LinetypeSegment > &  segments)

Description: Set all segments Parameters: segments - [in]

◆ SetTaper() [1/2]

bool ON_Linetype::SetTaper ( double  startWidth,
double  endWidth 

Description: Set the taper for this linetype to a simple start and end width

◆ SetTaper() [2/2]

bool ON_Linetype::SetTaper ( double  startWidth,
ON_2dPoint  taperPoint,
double  endWidth 

Description: Set the taper for this linetype with a single taper point

◆ SetWidth()

void ON_Linetype::SetWidth ( double  width)

Description: Set the width of the linetype

◆ SetWidthUnits()

void ON_Linetype::SetWidthUnits ( ON::LengthUnitSystem  units)

Description: Set the units used to define the linetype width None = width is defined in pixels (default) Unset = width is the same as the document's unitsystem

◆ TaperPoints()

const ON_SimpleArray<ON_2dPoint>* ON_Linetype::TaperPoints ( ) const

Description: List of points defining a taper. For each point in the taper the point's x value is between 0.00 and 1.00 and represents the % along the length of the curve the point's y value is the width used at x Returns nullptr if no taper points exist for this linetype

◆ Width()

double ON_Linetype::Width ( ) const

Description: Width of the linetype

◆ WidthUnits()

ON::LengthUnitSystem ON_Linetype::WidthUnits ( ) const

Description: Units used to define the linetype width None = width is defined in pixels (default) Unset = width is the same as the document's unitsystem

◆ Write()

bool ON_Linetype::Write ( ON_BinaryArchive ) const

Description: Write to file

Reimplemented from ON_Object.

Member Data Documentation

◆ Border

const ON_Linetype ON_Linetype::Border

index = -8, id, name and pattern are set.

◆ ByLayer

const ON_Linetype ON_Linetype::ByLayer

index = -2, id, name and pattern are set.

◆ ByParent

const ON_Linetype ON_Linetype::ByParent

index = -3, id, name and pattern are set.

◆ Center

const ON_Linetype ON_Linetype::Center

index = -7, id, name and pattern are set.

◆ Continuous

const ON_Linetype ON_Linetype::Continuous

index = -1, id, name and pattern are set.

◆ DashDot

const ON_Linetype ON_Linetype::DashDot

index = -6, id, name and pattern are set.

◆ Dashed

const ON_Linetype ON_Linetype::Dashed

index = -5, id, name and pattern are set.

◆ Dots

const ON_Linetype ON_Linetype::Dots

index = -9, id, name and pattern are set.

◆ Hidden

const ON_Linetype ON_Linetype::Hidden

index = -4, id, name and pattern are set.

◆ Unset

const ON_Linetype ON_Linetype::Unset

no attributes are set.