NoteEntity

Functions

NoteEntity

NoteEntity

~NoteEntity

void

Set

NoteEntity const &

operator=

Type

GetType

unsigned int

GetStringCount

void

GetStrings

void

SetStrings

Detailed Description

class NoteEntity : public PMI::Entity

This class represents a single or multi-line block of text.

Public Functions

NoteEntity(HC_KEY segment_key = (-1L))

Constructs a NoteEntity object. It requires specifying the segment key where the NoteEntity will insert associated geometry.

NoteEntity(NoteEntity const &that)
virtual ~NoteEntity()
void Set(NoteEntity const &that)
NoteEntity const &operator=(NoteEntity const &that)
inline virtual Type GetType() const
Returns

the PMI::Type for this entity. Overridden by subclasses.

unsigned int GetStringCount() const
Returns

the number of strings for this NoteEntity

void GetStrings(unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const

Gets the strings for this NoteEntity.

Parameters

  • out_count – the number of strings for this NoteEntity. Returned to the user.

  • out_strings – the array of strings for this NoteEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

  • out_text_attributes – the array of TextAttributes for the strings for this NoteEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

void SetStrings(unsigned int in_count, String const in_strings[], TextAttributes const in_text_attributes[])

Sets the strings for this NoteEntity. These will replace any existing strings.

Parameters

  • in_count – the number of strings in the array

  • in_strings – the array of strings for this NoteEntity

  • in_text_attributes – the array of TextAttributes for the strings for this NoteEntity