IG::Entity Class

Entity Class

Enums

STATE#

CLAMP#

CLAMP_HEIGHT_MODE#

ANIM_DIR#

ANIM_LOOP#

ANIM_STATE#

COORD_SYSTEM#

Members

int getID ( ) #

Return value

const Ptr<Node> & getNode ( ) #

Return value

const Ptr<NodeReference> & getNodeReference ( ) #

Return value

void setGeoPosition ( const Math::Vec3 & position ) #

Arguments

• const Math::Vec3 & position - New geo-coordinates of entity position to be set.

Math::Vec3 getGeoPosition ( ) #

Return value

void setRotationEuler ( const Math::vec3 & euler ) #

Arguments

• const Math::vec3 & euler - Entity rotation euler angles to set.

void setRotationEuler ( const Math::vec3 & euler, double timestamp ) #

Arguments

• const Math::vec3 & euler - Entity rotation euler angles to set.
• double timestamp - Timestamp, indicating the time when rotation is to be set.

Math::vec3 getRotationEuler ( ) #

Return value

void setType ( int id ) #

<entity_types>
	<entity id="111" name="b52">
	</entity>
</entity_types>

Arguments

• int id - Entity type to be set. 0 removes the entity from the scene.

int getType ( ) #

<entity_types>
	<entity id="111" name="b52">
	</entity>
</entity_types>

Return value

void setState ( Entity::STATE id ) #

Arguments

• Entity::STATE id - Entity state to be set.

Entity::STATE getState ( ) #

Return value

void setCollision ( int enabled ) #

Arguments

• int enabled - 1 to enable collision detecton for the entity; 0 — to disable.

int getCollision ( ) #

Return value

void setParent ( Entity * entity ) #

Arguments

• Entity * entity - Parent entity.

void unparent ( ) #

int getParentID ( ) #

Return value

int getAttachState ( ) #

Return value

void setAlpha ( int byte_value ) #

Arguments

• int byte_value - Alpha value to be set.

int getAlpha ( ) #

Return value

void setInheritAlpha ( bool enabled ) #

Arguments

• bool enabled - true the entity shall use the alpha value of its parent; false — the entity shall use its own alpha value.

int isInheritAlpha ( ) #

Return value

void setGround ( Ptr<ObjectTerrainGlobal> terrain ) #

Arguments

• Ptr<ObjectTerrainGlobal> terrain - Global terrain to be used by the entity for ground clamping.

void setGroundClamp ( Entity::CLAMP clamp ) #

Arguments

• Entity::CLAMP clamp - Ground/Ocean Clamp parameter value.

Entity::CLAMP getGroundClamp ( ) #

Return value

void setGroundClampHeightMode ( Entity::CLAMP_MODE height_mode ) #

Arguments

• Entity::CLAMP_MODE height_mode - Clamp height mode parameter value.

Entity::CLAMP_MODE getGroundClampHeightMode ( ) #

Return value

void setAnimationDirection ( Entity::ANIM_DIR animation_direction ) #

Arguments

• Entity::ANIM_DIR animation_direction - Direction of the entity's animation playback.

Entity::ANIM_DIR getAnimationDirection ( ) #

Return value

void setAnimationLoop ( Entity::ANIM_LOOP animation_loop ) #

Arguments

• Entity::ANIM_LOOP animation_loop - Mode of the entity's animation playback.

Entity::ANIM_LOOP getAnimationLoop ( ) #

Return value

void setAnimationState ( Entity::ANIM_STATE animation_state ) #

Arguments

• Entity::ANIM_STATE animation_state - State of the entity's animation playback.

Entity::ANIM_STATE getAnimationState ( ) #

Return value

void setInterpolation ( int id ) #

Arguments

• int id - 1 to enable interpolation and extrapolation; 0 — to disable.

int isInterpolation ( ) #

Return value

void setExtrapolationCoordSystem ( Entity::COORD_SYSTEM animation_state ) #

Arguments

• Entity::COORD_SYSTEM animation_state - Coordinate system used for extrapolation.

Entity::COORD_SYSTEM getExtrapolationCoordSystem ( ) #

Return value

void setVelocity ( const Math::Vec3 & linear, const Math::vec3 & angular_deg ) #

Arguments

• const Math::Vec3 & linear - Linear velocity vector to be set.
• const Math::vec3 & angular_deg - Angular velocity vector (roll, pitch, yaw), in degrees per second.

const Math::Vec3 & getLinearVelocity ( ) #

Return value

const Math::vec3 & getAngularVelocity ( ) #

Return value

void setAcceleration ( const Math::Vec3 & linear, const Math::vec3 & angular_deg ) #

Arguments

• const Math::Vec3 & linear - Linear acceleration vector to be set.
• const Math::vec3 & angular_deg - Angular acceleration vector (roll, pitch, yaw), in degrees per second.

const Math::Vec3 & getLinearAcceleration ( ) #

Return value

const Math::vec3 & getAngularAcceleration ( ) #

Return value

Component * getComponent ( int id ) #

Arguments

• int id - ID of the component.

Return value

ArticulatedPart * getArticulatedPart ( int id ) #

Arguments

• int id - ID of the articulated part.

Return value

CollisionSegment * getCollisionSegment ( int id ) #

Arguments

• int id - ID of the collision segment.

Return value

Vector < IG::CollisionSegment * > getCollisionSegments ( ) #

CollisionVolume * getCollisionVolume ( int id ) #

Arguments

• int id - ID of the collision volume.

Return value

Vector < IG::CollisionVolume * > getCollisionVolumes ( ) #

const Unigine::Vector< Ptr<Node> > & getObjects ( ) #

Return value