ViewEntity

class PMI::ViewEntity

This class represents a view, or a collection of PMI entities.

Methods

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

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

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

virtual

void PMI::ViewEntity::Set(ViewEntity const &that)
ViewEntity const &PMI::ViewEntity::operator=(ViewEntity const &that)
void PMI::ViewEntity::GetCamera(Camera &out_camera) const

const

Gets the camera associated with this ViewEntity. Returned to the user.

void PMI::ViewEntity::GetCamera(Point &out_position, Point &out_target, Point &out_up_vector, float &out_field_width, float &out_field_height, char out_projection[128])

Gets the camera associated with this ViewEntity. Returned to the user.

void PMI::ViewEntity::GetCamera(float out_position[3], float out_target[3], float out_up_vector[3], float &out_field_width, float &out_field_height, char out_projection[128])

Gets the camera associated with this ViewEntity. Returned to the user.

void PMI::ViewEntity::SetCamera(Camera const &in_camera)

Sets the camera associated with this ViewEntity. This will replace an existing camera.

void PMI::ViewEntity::SetCamera(Point const &in_position, Point const &in_target, Point const &in_up_vector, float in_field_width, float in_field_height, char const in_projection[128])

Sets the camera associated with this ViewEntity. This will replace an existing camera.

void PMI::ViewEntity::SetCamera(float const in_position[3], float const in_target[3], float const in_up_vector[3], float in_field_width, float in_field_height, char const in_projection[128])

Sets the camera associated with this ViewEntity. This will replace an existing camera.

void PMI::ViewEntity::GetFrame(Frame &out_frame) const

const

Gets the Frame associated with this ViewEntity. Returned to the user.

void PMI::ViewEntity::SetFrame(Frame const &in_frame)

Sets the Frame associated with this ViewEntity. This will replace an existing Frame.

void PMI::ViewEntity::GetName(String &out_name) const

const

Gets the name associated with this ViewEntity. Returned to the user.

void PMI::ViewEntity::SetName(String const &in_name)

Sets the name associated with this ViewEntity. This will replace an existing name.

void PMI::ViewEntity::SetName(char const *in_utf8_string)

Sets the name associated with this ViewEntity. This will replace an existing name.

Parameters

in_utf8_string: a string that is assumed to already be utf8 encoded.
unsigned int PMI::ViewEntity::GetAssociatedEntityCount() const

const

Returns

the number of associated entities for this ViewEntity
void PMI::ViewEntity::GetAssociatedEntities(unsigned int &out_count, Entity out_entities[]) const

const

Gets the entities associated with this ViewEntity

Parameters

out_count: the number of associated entities. Returned to the user.

out_entities: the array of entities associated with this ViewEntity. 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::ViewEntity::SetAssociatedEntities(unsigned int in_count, Entity const in_entities[])

Sets the entities associated with this ViewEntity. These will replace any existing entity associations.

Parameters

in_count: the number of associated entities

in_entities: the array of entities to associate with this ViewEntity

Variables

PMII::PrivateImpl *PMI::ViewEntity::impl_

protected

PMII::PrivateImpl