CigiEntityControl Class

CigiEntityControl Class

Members

---

int getEntityID ( ) #

Returns the entity ID.

Return value

Entity ID.

int getParentID ( ) #

Returns the ID of the entity parent.

Return value

Entity parent ID.

int getEntityType ( ) #

Returns the current entity type.

Return value

Entity type.

int getEntityState ( ) #

Returns the current entity state.

Return value

Current entity state. One of the CIGI_STATE_* values.

int getAttachState ( ) #

Returns the value of the Attach State parameter. It specifies whether the entity is be attached as a child to a parent.

Return value

Attach State parameter value. 1 the entity shall be or remain attached to the entity specified by the Parent ID parameter; 0 - the entity shall be detached from its parent.

int getCollision ( ) #

Returns the value indicating if collision detecton shall be enabled for the entity.

Return value

Collision Detection Enable parameter value. 1 collision detecton for the entity shall be enabled; 0 - collision detecton for the entity shall be enabled.

int getInheritAlpha ( ) #

Returns the value indicating if the entity uses the alpha value of its parent.

Return value

1 if the entity uses the alpha value of its parent; otherwise, 0.

int getGroundClamp ( ) #

Returns the value of the Ground/Ocean Clamp parameter.

Return value

Ground/Ocean Clamp parameter value. One of the CIGI_ENTITY_* values.

int getAnimationBack ( ) #

Returns the current entity's animation playback direction.

Return value

Direction of the entity's animation playback. One of the ANIM_DIR_* values.

int getAnimationLoop ( ) #

Returns the current entity's animation playback mode.

Return value

Mode of the entity's animation playback. One of the ANIM_LOOP_* values.

int getAnimationState ( ) #

Returns the current entity's animation playback state.

Return value

State of the entity's animation playback. One of the ANIM_STATE_* values.

int getInterpolation ( ) #

Returns a value indicating if interpolation and extrapolation are enabled.

Return value

1 if interpolation and extrapolation are enabled; otherwise, 0.

int getAlpha ( ) #

Returns the current alpha value, that determines transparency of entity geometry.

Return value

Alpha value.

const vec3 & getRotation ( ) #

Returns the current entity rotation value.

Return value

Entity rotation value

const dvec3 & getPosition ( ) #

Returns the current entity position.

Return value

Entity position coordinates.