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

CRhinoHatchPattern class. More...

#include <rhinoSdkHatchPattern.h>

Inheritance diagram for CRhinoHatchPattern:
ON_HatchPattern ON_ModelComponent ON_Object

Public Member Functions

void DrawPattern (HDC pDC, const ON_4iRect &rect, double angle, COLORREF bkColor, COLORREF fgColor) const
 Draw a swatch of the pattern into a rectangle. More...
unsigned int LinkedInstanceDefinitionSerialNumber () const
unsigned int WorksessionReferenceModelSerialNumber () const
- Public Member Functions inherited from ON_HatchPattern
 ON_HatchPattern () ON_NOEXCEPT
 ON_HatchPattern (const ON_HatchPattern &)
 ~ON_HatchPattern ()=default
int AddHatchLine (const ON_HatchLine &line)
const ON_wStringDescription () const
void Dump (ON_TextLog &) const override
 for debugging More...
ON_HatchPattern::HatchFillType FillType () const
 Interface. More...
const ON_HatchLineHatchLine (int index) const
int HatchLineCount () const
 Interface functions for line hatches. More...
const ON_ClassArray< ON_HatchLine > & HatchLines () const
bool IsValid (class ON_TextLog *text_log=nullptr) const override
 ON_Object overrides. More...
ON_HatchPatternoperator= (const ON_HatchPattern &)=default
bool Read (ON_BinaryArchive &) override
void RemoveAllHatchLines ()
bool RemoveHatchLine (int index)
void SetDescription (const wchar_t *pDescription)
void SetFillType (ON_HatchPattern::HatchFillType fill_type)
int SetHatchLines (const ON_ClassArray< ON_HatchLine > &lines)
int SetHatchLines (size_t count, const ON_HatchLine *lines)
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 bool CreateDisplay (const ON_HatchPattern *pattern, const ON_Hatch *hatch, double pattern_scale, ON_3dVector xdir, ON_3dVector ydir, ON_SimpleArray< ON_NurbsCurve * > &bounds, ON_SimpleArray< ON_Line > &lines, ON_Brep *&pBrep)
static bool CreateDisplay (const ON_HatchPattern *pattern, const ON_Hatch *hatch, ON_SimpleArray< ON_NurbsCurve * > &bounds, ON_SimpleArray< ON_Line > &lines, ON_Brep *&pBrep)
 bool Create( const ON_Plane& plane, const ON_3dPoint& p0, const ON_3dPoint& p1, ON_SimpleArray<ON_Line> lines); More...
static unsigned int NextRuntimeSerialNumber ()
- Static Public Member Functions inherited from ON_HatchPattern
static int Compare (const ON_HatchPattern &a, const ON_HatchPattern &b)
 compare everything except Index() value. More...
static int CompareAppearance (const ON_HatchPattern &a, const ON_HatchPattern &b)
static const ON_HatchPatternFromModelComponentRef (const class ON_ModelComponentReference &model_component_reference, const ON_HatchPattern *none_return_value)
static ON_HatchPattern::HatchFillType HatchFillTypeFromUnsigned (unsigned hatch_fill_type_as_unsigned)
- 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

const unsigned int m_hatchpattern_sn
int m_remap_index = -1
int m_sort_index = -1
 Runtime index used to sort layers in layer dialog. More...


class CRhinoHatchPatternTable

Additional Inherited Members

- Public Types inherited from ON_HatchPattern
enum  HatchFillType : unsigned int { HatchFillType::Solid = 0, HatchFillType::Lines = 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. /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_HatchPattern
static const ON_HatchPattern Grid
 index = -6, id set, unique and persistent More...
static const ON_HatchPattern Grid60
 index = -7, id set, unique and persistent More...
static const ON_HatchPattern Hatch1
 index = -2, id set, unique and persistent More...
static const ON_HatchPattern Hatch2
 index = -3, id set, unique and persistent More...
static const ON_HatchPattern Hatch3
 index = -4, id set, unique and persistent More...
static const ON_HatchPattern HatchDash
 index = -5, id set, unique and persistent More...
static const ON_HatchPattern Plus
 index = -8, id set, unique and persistent More...
static const ON_HatchPattern Solid
 index = -1, id set, unique and persistent More...
static const ON_HatchPattern Squares
 index = -9, id set, unique and persistent More...
static const ON_HatchPattern Unset
 index = ON_UNSET_INT_INDEX, id = nil 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

CRhinoHatchPattern class.

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

◆ CreateDisplay() [1/2]

static bool CRhinoHatchPattern::CreateDisplay ( const ON_HatchPattern pattern,
const ON_Hatch hatch,
double  pattern_scale,
ON_3dVector  xdir,
ON_3dVector  ydir,
ON_SimpleArray< ON_NurbsCurve * > &  bounds,
ON_SimpleArray< ON_Line > &  lines,
ON_Brep *&  pBrep 

11 Nov, 2010 - Lowell - Added to support paper space scaling of hatches Same as above, but the pattern_scale argument is a multipier for the pattern scale stored on the hatch.

◆ CreateDisplay() [2/2]

static bool CRhinoHatchPattern::CreateDisplay ( const ON_HatchPattern pattern,
const ON_Hatch hatch,
ON_SimpleArray< ON_NurbsCurve * > &  bounds,
ON_SimpleArray< ON_Line > &  lines,
ON_Brep *&  pBrep 

bool Create( const ON_Plane& plane, const ON_3dPoint& p0, const ON_3dPoint& p1, ON_SimpleArray<ON_Line> lines);

Description: Creates the display graphics for a Hatch from the Hatch and HatchPattern definitions. Parameters: pattern [in] - the hatch pattern to draw hatch [in] - The hatch contains 3d plane for the display objects scale to apply to the pattern definition rotation to apply to the pattern definition 2d boundary loops for the hatched area in hatch plane coordinates bounds [out] - 3d boundary curves for the hatch The first curve in the array is the outer boundary and the rest are inners lines [out] - 3d line segments representing the applied pattern There may be no lines if the hatch uses a different fill type pBrep [out] - Trimmed planar brep used for solid fill hatch display Will be NULL if the hatch isn't solid filled Returns: true for success, false for failure

◆ DrawPattern()

void CRhinoHatchPattern::DrawPattern ( HDC  pDC,
const ON_4iRect rect,
double  angle,
COLORREF  bkColor,
COLORREF  fgColor 
) const

Draw a swatch of the pattern into a rectangle.

◆ LinkedInstanceDefinitionSerialNumber()

unsigned int CRhinoHatchPattern::LinkedInstanceDefinitionSerialNumber ( ) const

Returns: 0: The hatch pattern is not part of a linked instance definition 1-1000: These numbers are reserved for future use. >1000: CRhinoDoc::m_instance_defintion_table.FindBySerialNumber() can be used to find the instance defintion. Remarks: The linked instance defintion serial number is a runtime value. It is not saved in files and it is generally different the next time a file is read.

◆ NextRuntimeSerialNumber()

static unsigned int CRhinoHatchPattern::NextRuntimeSerialNumber ( )

◆ WorksessionReferenceModelSerialNumber()

unsigned int CRhinoHatchPattern::WorksessionReferenceModelSerialNumber ( ) const

Returns: Worksession reference model id. 0: hatch pattern is not in a reference model. 1: hatch pattern is in an unidentified worksession reference model. 2-1000: reserved for future use >1000: Serial number of the worksession reference model.
Remarks: The reference model serial number is a runtime value. It is not saved in files and it is generally different the next time a file is read.

Friends And Related Function Documentation

◆ CRhinoHatchPatternTable

friend class CRhinoHatchPatternTable

Member Data Documentation

◆ m_hatchpattern_sn

const unsigned int CRhinoHatchPattern::m_hatchpattern_sn

Runtime serial number of this hatch pattern. This serial number is unique for each hatch pattern 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 CRhinoHatchPattern::m_remap_index = -1

Used for font index remapping during I/O operations. It is a runtime variable and should be ignored by everything except CRhinoDoc::Read3DM() and CRhinoDoc::Write3DM().

◆ m_sort_index

int CRhinoHatchPattern::m_sort_index = -1

Runtime index used to sort layers in layer dialog.