This page has been translated automatically.
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
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine 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
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

ShapeCapsule Class

Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Inherits: Shape

This class is used to create collision shape in the form of a capsule.

See Also#

  • A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/shapes/ folder:
    • capsule_00
    • capsule_01
    • capsule_02
    • capsule_03
    • shapes_00

ShapeCapsule Class

Members


static ShapeCapsule ( ) #

Constructor. Creates a new capsule with the zero radius and the zero height.

static ShapeCapsule ( float radius, float height ) #

Constructor. Creates a new capsule with given dimensions.

Arguments

  • float radius - Radius of the capsule in units.
  • float height - Height of the capsule in units.

static ShapeCapsule ( Body body, float radius, float height ) #

Constructor. Creates a new capsule with given dimensions and adds it to a given body.

Arguments

  • Body body - Body, to which the capsule will belong.
  • float radius - Radius of the capsule in units.
  • float height - Height of the capsule in units.

void setHeight ( float height ) #

Sets a height of the capsule.

Arguments

  • float height - Height of the capsule in units.

float getHeight ( ) #

Returns the current height of the capsule.

Return value

Height of the capsule in units.

void setRadius ( float radius ) #

Sets a radius of the capsule.

Arguments

  • float radius - Radius of the capsule in units.

float getRadius ( ) #

Returns the current radius of the capsule.

Return value

Radius of the capsule in units.

Vec3 getBottomCap ( ) #

Returns the coordinates of the center of the top hemisphere of the capsule.

Return value

Coordinates of the center of the capsule's top hemisphere.

Vec3 getTopCap ( ) #

Returns the coordinates of the center of the bottom hemisphere of the capsule.

Return value

Coordinates of the center of the capsule's bottom hemisphere.
Last update: 2020-07-31
Build: ()