UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
FAQ
Программирование
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes

Unigine::Cigi::ICigiEntityControl Class

Header: #include <CigiClientInterface.h>
Inherits: ICigiHostPacket
Warning
The CIGIClient plugin is deprecated and no longer supported. For more information on working with CIGI please refer to the IG Application section.

This class represents the CIGI Entity Control packet interface.

Notice
CIGI plugin must be loaded.

ICigiEntityControl Class

Members


int getEntityID ( ) #

Returns the entity ID specified in the packet.

Return value

Entity ID.

int getParentID ( ) #

Returns the ID of the entity parent specified in the packet.

Return value

Entity parent ID.

int getEntityType ( ) #

Returns the type of the entity specified in the packet.

Return value

Entity Type.

int getEntityState ( ) #

Returns the value of the Entity State parameter specified in the packet.

Return value

Entity State parameter value. One of the CIGI_STATE_* values.

int getAttachState ( ) #

Returns the value of the Attach State parameter specified in the packet. It specifies whether the entity will 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 of the Collision Detection Enable parameter specified in the packet. It specifies whether 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 disabled.

int getInheritAlpha ( ) #

Returns the value of the Inherit Alpha parameter specified in the packet.

Return value

Inherit Alpha parameter value.

int getGroundClamp ( ) #

Returns the value of the Ground/Ocean Clamp parameter specified in the packet.

Return value

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

int getAnimationBack ( ) #

Returns the value of the Animation Direction parameter specified in the packet.

Return value

Animation Direction parameter value.

int getAnimationLoop ( ) #

Returns the value of the Animation Loop parameter specified in the packet.

Return value

Animation Loop parameter value.

int getAnimationState ( ) #

Returns the value of the Animation State parameter specified in the packet.

Return value

Animation State parameter value.

int getInterpolation ( ) #

Returns the value of the Smoothing Enable parameter specified in the packet.

Return value

Smoothing Enable parameter value.

int getAlpha ( ) #

Returns the value of the Alpha parameter specified in the packet.

Return value

Alpha parameter value.

const Math::vec3 & getRotation ( ) #

Returns the current entity rotation.

Return value

Entity rotation euler angles.

const Math::Vec3 & getPosition ( ) #

Returns the current entity position.

Return value

Entity position coordinates.
Last update: 28.11.2019