NoteEntity

class PMI::NoteEntity

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

Inherits from: PMI::Entity

Methods

PMI::NoteEntity::NoteEntity(HC_KEY segment_key = INVALID_KEY)

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

PMI::NoteEntity::NoteEntity(NoteEntity const &that)
virtual PMI::NoteEntity::~NoteEntity()

virtual

void PMI::NoteEntity::Set(NoteEntity const &that)
NoteEntity const &PMI::NoteEntity::operator=(NoteEntity const &that)
virtual Type PMI::NoteEntity::GetType() const

const virtual

Returns

the PMI::Type for this entity. Overridden by subclasses.
unsigned int PMI::NoteEntity::GetStringCount() const

const

Returns

the number of strings for this NoteEntity
void PMI::NoteEntity::GetStrings(unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const

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 PMI::NoteEntity::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