Module `igeScene`

IGE Scene Module

Functions

def getVersion(...): Return the version of igeScene module.

Classes

class AmbientLight

Ancestors

Component

Instance variables

var direction: Ambient Direction. Type: Vec3
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var groundColor: Ambient Ground Color. Type: Vec3
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var skyColor: Ambient Sky Color. Type: Vec3

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Animator

Ancestors

Component

Instance variables

var controllerPath: Path to animator controller. Type: string
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var isInitialized: [Readonly] Return true if the animator has been initialized, otherwise return false. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var parameterCount: [Readonly] Return number of parameters the animator has. Type: int
var speed: Animation playing speed multiplier. Type: float
var updateMode: Animation update mode: Normal = 0, AnimatePhysics = 1, UnscaledTime = 2. Type: int

Methods

def getValue(...): Get value of the given parameter.

Animator.getValue(param: string)

Return

value: float | int | bool
def hasState(...): Check if the animator controller has the given state.

Animator.hasState(stateName: string)

Return

result: bool
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …
def play(...): Play animation at the given state name.

Animator.play(stateName: string)

Return

result: bool
def rebind(...): Rebinding the animator with the controller, reseting all the states and parameters.

Animator.rebind()

Return

result: bool
def resetTrigger(...): Reset trigger the given parameter.

Animator.resetTrigger(param: string)

Return

result: bool
def setTrigger(...): Set trigger the given parameter.

Animator.setTrigger(param: string)

Return

result: bool
def setValue(...): Set value of the given parameter.

Animator.setValue(param: string, value: float | int | bool)

Return

result: bool

class AudioListener

Ancestors

Component

Instance variables

var enable: Enable/disable. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class AudioManager

Ancestors

Component

Static methods

def getInstance(...): Get AudioManager singleton instance.

AudioManager.getInstance()

Return

Singleton instance of AudioManager

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var globalVolume: Global volume. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject

Methods

def getActiveListener(...): Get the active listener instance.

AudioManager.getInstance().getActiveListener()

Return

AudioListener or None
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class AudioSource

Ancestors

Component

Instance variables

var attenuationFactor: Audio attenuation roll-off factor. Type: float
var attenuationModel: Audio attenuation model (0: no attenuation, 1: inverse distance, 2: linear distance, 3: exponential distance). Type: float
var dopplerFactor: Audio doppler factor. Type: float
var enable: Enable/disable. Type: bool
var loop: Should audio to be looped. Type: bool
var maxDistance: Audio max distance. Type: float
var minDistance: Audio min distance. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var pan: Audio panning (-1.f: left, 0: center, 1.f: right). Type: float
var path: Path to the audio file. Type: string
var playOnEnabled: Auto play audio when enable. Type: bool
var singleInstance: Should audio to be single instance (stop previous instance before playing new instance). Type: bool
var stream: Streamed or fully loaded on memory. Type: bool
var velocity: Audio velocity. Type: Vec3
var volume: Audio volume (0.f - 1.f). Type: float

Methods

def isPaused(...)

Check whether the audio is paused.

def isStopped(...)

Check whether the audio is stopped.

def onUpdate(...)

Inherited from: Component.onUpdate

Utility to force update component, eg transform …

def pause(...)

Pause audio.

def play(...)

Play audio.

def resume(...)

Resume audio.

def seek(...)

Seek audio by seconds. Parameters

seconds : float
    seek time in second

def stop(...)

Stop audio.

class BoxCollider

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var size: The size of the box. Type: Vec3

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Camera

Ancestors

Component

Instance variables

var aspectRatio: Aspect Ratio. Type: float
var camera: Get internal camera instance. Type: igeCore.Camera
var clearColor: Color to clear before render. Type: Vec4
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var far: Far Plane. Type: float
var fieldOfView: Field Of View. Type: float
var lockOnTarget: Lock On Target. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var near: Near Plane. Type: float
var orthoHeight: Ortho Height. Type: float
var orthoProjection: Orthographics Projection. Type: bool
var orthoWidth: Ortho Width. Type: float
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var pan: Pan (Y-axis). Type: float
var position: Position. Type: Vec3
var projectionMatrix: ProjectionMatrix. Type: Mat4
var roll: Roll (Z-axis). Type: float
var rotation: Rotation. Type: Quat
var screenMatrix: Screen Matrix. Type: Mat4
var screenOffset: Screen Offset. Type: Vec2
var screenRadian: Screen Radian. Type: float
var screenScale: Screen Scale. Type: Vec2
var target: Locked Target. Type: Vec3
var tilt: Tilt (X-axis). Type: float
var upAxis: Up Axis, default 1. Type: int
var viewInverseMatrix: View Inverse Matrix. Type: Mat4
var widthBased: Width Based. Type: bool
var worldTarget: Locked Target in world coordination. Type: Vec3

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Canvas

Ancestors

Component

Instance variables

var design_size: Design canvas size. Type: string
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var target_size: Target canvas size. Type: Vec2

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class CapsuleCollider

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var height: The height of the capsule. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var radius: The radius of the capsule. Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Component

Subclasses

Instance variables

var enable: Enable/disable this component. Type: bool
var name: The name of the component. Type: string
var owner: The scene object that own this component. Type: SceneObject

Methods

def onUpdate(...)

Utility to force update component, eg transform…

Component().onUpdate(dt: float) -> bool

Parameters

dt : float
    Delta time, should be 0.f in case of force update.

Return:

True: if updated
False: if failed

class DirectionalLight

Ancestors

Component

Instance variables

var color: Directional Light Color. Type: Vec3
var direction: Directional Light Direction. Type: Vec3
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var intensity: Directional Light Intensity. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Dof6Constraint

Ancestors

PhysicConstraint

Instance variables

var angularBounce: Angular bounce vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularDamping: Angular damping vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularLowerLimit: Angular lower limit vector. Default (1.0, 1.0, 1.0). Type: Vec3
var angularMaxMotorForce: Angular motor force vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularMotorEnabled: Angular motor enabled vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularServoEnabled: Angular servo enabled vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularServoTarget: Angular servo target vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularSpringEnabled: Angular spring enabled vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularStiffness: Angular spring stiffness vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularTargetVelocity: Angular target velocity vector. Default (0.0, 0.0, 0.0). Type: Vec3
var angularUpperLimit: Angular upper limit vector. Default (0.0, 0.0, 0.0). Type: Vec3
var breakingImpulse: Inherited from: PhysicConstraint.breakingImpulse

Breaking impulse threshold. Default: Very big number. Type: float
var isBodiesCollisionEnabled: Inherited from: PhysicConstraint.isBodiesCollisionEnabled

Enable/disable collision between linked bodies. Default: true. Type: bool
var isEnabled: Inherited from: PhysicConstraint.isEnabled

Enable/disable this constraint. Default: true. Type: bool
var linearBounce: Linear bounce vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearDamping: Linear damping vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearLowerLimit: Linear lower limit vector. Default (1.0, 1.0, 1.0). Type: Vec3
var linearMaxMotorForce: Linear motor force vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearMotorEnabled: Linear motor enabled vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearServoEnabled: Linear servo enabled vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearServoTarget: Linear servo target vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearSpringEnabled: Linear spring enabled vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearStiffness: Linear spring stiffness vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearTargetVelocity: Linear target velocity vector. Default (0.0, 0.0, 0.0). Type: Vec3
var linearUpperLimit: Linear upper limit vector. Default (0.0, 0.0, 0.0). Type: Vec3
var other: Inherited from: PhysicConstraint.other

The physic object that linked to this constraint. Type: Rigidbody
var owner: Inherited from: PhysicConstraint.owner

The physic object that own this constraint. Type: Rigidbody
var type: Inherited from: PhysicConstraint.type

The type of the physic constraint. Type: int

class DynamicNavMesh

Instance variables

var aabbPading: Inherited from: NavMesh.aabbPading

Bounding box padding. Type: Vec3 Default: (1.0, 1.0., 1.0)
var agentHeight: Inherited from: NavMesh.agentHeight

Agent height. Type: float Default: 2.0
var agentMaxClimb: Inherited from: NavMesh.agentMaxClimb

Agent max vertical climb. Type: float Default: 0.9
var agentMaxSlope: Inherited from: NavMesh.agentMaxSlope

Agent max slope, the angle in DEG value. Type: float Default: 45.0
var agentRadius: Inherited from: NavMesh.agentRadius

Agent radius. Type: float Default: 0.6
var cellHeight: Inherited from: NavMesh.cellHeight

Cell Height Type: float Default: 0.2
var cellSize: Inherited from: NavMesh.cellSize

Cell size. Type: float Default: 0.3
var detailSampleDistance: Inherited from: NavMesh.detailSampleDistance

Detail sampling distance. Type: float Default: 0.6
var detailSampleMaxError: Inherited from: NavMesh.detailSampleMaxError

Detail sampling maximum error. Type: float Default: 1.0
var edgeMaxError: Inherited from: NavMesh.edgeMaxError

Edge max error. Type: float Default: 1.3
var edgeMaxLength: Inherited from: NavMesh.edgeMaxLength

Edge max length. Type: float Default: 12.0
var enable: Inherited from: NavMesh.enable

Enable/disable this component. Type: bool
var maxLayers: Max number of layers. Type: int
var maxObstacles: Max number of obstacles. Type: int
var name: Inherited from: NavMesh.name

The name of the component. Type: string
var owner: Inherited from: NavMesh.owner

The scene object that own this component. Type: SceneObject
var partitionType: Inherited from: NavMesh.partitionType

Partitioning type. WATERSHED = 0, MONOTONE = 1. Type: int Default: 0
var regionMergeSize: Inherited from: NavMesh.regionMergeSize

Region merge size. Type: float Default: 20.0
var regionMinSize: Inherited from: NavMesh.regionMinSize

Region minimum size. Type: float Default: 8.0
var tileSize: Inherited from: NavMesh.tileSize

Tile size. Type: int Limit: [1, 128] Default: 64

Methods

def build(...): Inherited from: NavMesh.build

Build the entire navigation mesh …
def getAABB(...): Inherited from: NavMesh.getAABB

Return the bounding box of this NavMesh …
def getNumTiles(...): Inherited from: NavMesh.getNumTiles

Return number of tiles by X and Z axis …
def getTileAABB(...): Inherited from: NavMesh.getTileAABB

Return number of tiles by X and Z axis …
def getTileIndex(...): Inherited from: NavMesh.getTileIndex

Return index of the tile contains the given position, by X and Z axis …
def getWorldAABB(...): Inherited from: NavMesh.getWorldAABB

Return the bounding box of this NavMesh in world space …
def onUpdate(...): Inherited from: NavMesh.onUpdate

Utility to force update component, eg transform …

class EditableFigure

Ancestors

Component

Instance variables

var depthTestEnabled: Whether depth test to be enabled or disabled. Type: bool Default: true
var depthWriteEnabled: Whether depth write to be enabled or disabled. Type: bool Default: true
var doubleSideEnabled: Whether double side render to be enabled or disabled. When disable, it use back face culling. Type: bool Default: true
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var figure: Editable Figure instance. Type: EditableFigure
var fogEnabled: Whether fog to be enabled or disabled. Type: bool Default: false
var frontFaceCullingEnabled: Whether front face culling to be enabled or disabled. Only affected when doubleSideEnable set to false. Type: bool Default: false
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var path: Path to figure file. Type: string
var scissorTestEnabled: Whether scissor test to be enabled or disabled. Type: bool Default: false
var updateRatio: Frame update ratio (speedup/slower effects). Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Environment

Ancestors

Component

Instance variables

var distanceFogAlpha: Distance Fog Alpha. Type: float
var distanceFogColor: Distance Fog Color. Type: Vec3
var distanceFogFar: Distance Fog Far. Type: float
var distanceFogNear: Distance Fog Near. Type: float
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var environment: Environment instance. Type: pyxieEnvironment
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var shadowColor: Shadow Color. Type: Vec3
var shadowDensity: Shadow Density. Type: float
var shadowWideness: Shadow Wideness. Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Figure

Ancestors

Component

Instance variables

var depthTestEnabled: Whether depth test to be enabled or disabled. Type: bool Default: true
var depthWriteEnabled: Whether depth write to be enabled or disabled. Type: bool Default: true
var doubleSideEnabled: Whether double side render to be enabled or disabled. When disable, it use back face culling. Type: bool Default: true
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var figure: Figure instance. Type: Figure
var fogEnabled: Whether fog to be enabled or disabled. Type: bool Default: false
var frontFaceCullingEnabled: Whether front face culling to be enabled or disabled. Only affected when doubleSideEnable set to false. Type: bool Default: false
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var path: Path to figure file. Type: string
var scissorTestEnabled: Whether scissor test to be enabled or disabled. Type: bool Default: false
var updateRatio: Frame update ratio (speedup/slower effects). Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class FixedConstraint

Ancestors

PhysicConstraint

Instance variables

var breakingImpulse: Inherited from: PhysicConstraint.breakingImpulse

Breaking impulse threshold. Default: Very big number. Type: float
var isBodiesCollisionEnabled: Inherited from: PhysicConstraint.isBodiesCollisionEnabled

Enable/disable collision between linked bodies. Default: true. Type: bool
var isEnabled: Inherited from: PhysicConstraint.isEnabled

Enable/disable this constraint. Default: true. Type: bool
var other: Inherited from: PhysicConstraint.other

The physic object that linked to this constraint. Type: Rigidbody
var owner: Inherited from: PhysicConstraint.owner

The physic object that own this constraint. Type: Rigidbody
var type: Inherited from: PhysicConstraint.type

The type of the physic constraint. Type: int

class HingeConstraint

Ancestors

PhysicConstraint

Instance variables

var anchor: Anchor point. Default (0.0, 0.0, 0.0). Type: Vec3
var axis1: The first axis. Default (0.0, 1.0, 0.0). Type: Vec3
var axis2: The second axis. Default (1.0, 0.0, 0.0). Type: Vec3
var breakingImpulse: Inherited from: PhysicConstraint.breakingImpulse

Breaking impulse threshold. Default: Very big number. Type: float
var isBodiesCollisionEnabled: Inherited from: PhysicConstraint.isBodiesCollisionEnabled

Enable/disable collision between linked bodies. Default: true. Type: bool
var isEnabled: Inherited from: PhysicConstraint.isEnabled

Enable/disable this constraint. Default: true. Type: bool
var lowerLimit: Lower angle limit in radian. Default -3.14. Type: float
var other: Inherited from: PhysicConstraint.other

The physic object that linked to this constraint. Type: Rigidbody
var owner: Inherited from: PhysicConstraint.owner

The physic object that own this constraint. Type: Rigidbody
var type: Inherited from: PhysicConstraint.type

The type of the physic constraint. Type: int
var upperLimit: Upper angle limit in radian. Default 3.14. Type: float

class MeshCollider

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var isConvex: Convex/concave setting. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class NavAgent

Ancestors

Component

Instance variables

var autoUpdatePosition: Agent auto update position Type: bool
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var height: Agent height Type: float
var id: Agent Id. Type: int
var maxAcceleration: Agent max acceleration Type: float
var maxSpeed: Agent max speed Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var navigationPushiness: Agent navigation pushiness Type: int
var obstacleAvoidanceType: Agent obstacle avoidance type Type: int
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var queryFilterType: Agent query filter type Type: int
var radius: Agent radius. Type: float
var targetPosition: Agent target position Type: float

Methods

def getPosition(...): Get the agent's current position.

Return: Vec3
def getVelocity(...): Get the agent's current velocity.

Return: Vec3
def hasArrived(...): Check if the agent arrived at the target position.

Return: bool
def hasTarget(...): Check if the agent has assigned target position.

Return: bool
def isInCrowd(...): Check if the agent is in crowd manager.

Return: bool
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …
def resetTarget(...): Reset the target.

Return: None

class NavAgentManager

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var maxAgentNumber: Max number of agents. Type: int
var maxAgentRadius: Max radius of agents. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var navMesh: Associated NavMesh instance. Type: NavMesh.
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject

Methods

def deactivateAllAgents(...): Deactivate all attached agents.

Return: None.
def findNearestPoint(...): Find the nearest point on the navigation mesh to a given point using the crowd initialized query extent and the specified query filter type.

Parameters

point: reference point Type: Vec3 queryFilterType: filter type Type: int

Return: nearest point in the mesh. Type: Vec3
def findPath(...): Find a path between world space points using the crowd initialized query extent and the specified query filter type. Return non-empty list of points if successful.

Parameters

start: start point Type: Vec3 end: end point Type: Vec3 queryFilterType: filter type Type: int

Return: list of path points. Type: list
def getAgents(...): Get the list of agents attached to this manager.

Return

Type: list
def getAreaCost(...): Get the cost of an area for the specified query filter type.

Parameters

queryFilterType: filter type Type: int areaID: areaId Type: int

Return: area cost. type: float.
def getAreasNumber(...): Get the number of configured area in the specified query filter type.

Parameters

queryFilterType: filter type Type: int

Return: Number of area for this query filter type. Type: int
def getDistanceToWall(...): Return distance to wall from a point using the crowd initialized query extent and the specified query filter type.

Parameters

point: reference point Type: Vec3 radius: max search radius Type: float queryFilterType: filter type Type: int

Return: hit pos. Type: Vec3
def getExcludeFlags(...): Get the exclude flags for the specified query filter type.

Parameters

queryFilterType: filter type Type: int

Return: included flag. type: int.
def getIncludeFlags(...): Get the include flags for the specified query filter type.

Parameters

queryFilterType: filter type Type: int

Return: included flag. type: int.
def getQueryFiltersNumber(...): Return the number of query filters configured in the crowd. Limit to 16. Type: int
def getRandomPoint(...): Return a random point on the navigation mesh using the crowd initialized query extent and the specified query filter type.

Parameters

queryFilterType: filter type Type: int

Return: a random point in the mesh. Type: Vec3
def getRandomPointInCircle(...): Return distance to wall from a point using the crowd initialized query extent and the specified query filter type. Maximum search radius must be specified.

Parameters

center: center of circle Type: Vec3 radius: radius of circle Type: float queryFilterType: filter type Type: int

Return: a random point in a circle in the mesh. Type: Vec3
def moveAlongSurface(...): Try to move along the surface from one point to another using the crowd initialized query extentand the specified query filter type.

Parameters

start: start point Type: Vec3 end: end point Type: Vec3 queryFilterType: filter type Type: int maxVisited: max number of visit Type: int

Return: new position. Type: Vec3.
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …
def raycast(...): Perform a walkability raycast on the navigation mesh between start and end using the crowd initialized query extent and the specified query filter type. Return the point where a wall was hit, or the end point if no walls.

Parameters

start: start point Type: Vec3 end: end point Type: Vec3 queryFilterType: filter type Type: int

Return: hit pos. Type: Vec3
def reactivateAllAgents(...): Reactivate all attached agents.

Return: None.
def setAreaCost(...): Get the cost of an area for the specified query filter type.

Parameters

queryFilterType: filter type Type: int areaID: areaId Type: int

Return: area cost. type: float.
def setExcludeFlags(...): Set the exclude flags for the specified query filter type.

Parameters

queryFilterType: filter type Type: int flags: included flags Type: int

Return: None.
def setIncludeFlags(...): Set the include flags for the specified query filter type.

Parameters

queryFilterType: filter type Type: int flags: included flags Type: int

Return: None.

class NavArea

Ancestors

Component

Instance variables

var aabb: The AABB box of the area. Type: AABBox
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var id: Area ID. Type: int
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var worldAabb: The AABB box of the area. Type: AABBox

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class NavMesh

Ancestors

Component

Subclasses

DynamicNavMesh

Instance variables

var aabbPading: Bounding box padding. Type: Vec3 Default: (1.0, 1.0., 1.0)
var agentHeight: Agent height. Type: float Default: 2.0
var agentMaxClimb: Agent max vertical climb. Type: float Default: 0.9
var agentMaxSlope: Agent max slope, the angle in DEG value. Type: float Default: 45.0
var agentRadius: Agent radius. Type: float Default: 0.6
var cellHeight: Cell Height Type: float Default: 0.2
var cellSize: Cell size. Type: float Default: 0.3
var detailSampleDistance: Detail sampling distance. Type: float Default: 0.6
var detailSampleMaxError: Detail sampling maximum error. Type: float Default: 1.0
var edgeMaxError: Edge max error. Type: float Default: 1.3
var edgeMaxLength: Edge max length. Type: float Default: 12.0
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var partitionType: Partitioning type. WATERSHED = 0, MONOTONE = 1. Type: int Default: 0
var regionMergeSize: Region merge size. Type: float Default: 20.0
var regionMinSize: Region minimum size. Type: float Default: 8.0
var tileSize: Tile size. Type: int Limit: [1, 128] Default: 64

Methods

def build(...): Build the entire navigation mesh.

Return

Type: bool
def getAABB(...): Return the bounding box of this NavMesh.

Return

Type: tuple
def getNumTiles(...): Return number of tiles by X and Z axis.

Return

Type: tuple(numTilesX, numTilesZ)
def getTileAABB(...): Return number of tiles by X and Z axis.

Parameters

tileX: index by X axis Type: int tileZ: index by Z axis Type: int

Return

Type: tuple
def getTileIndex(...): Return index of the tile contains the given position, by X and Z axis.

Parameters

position: reference position Type: Vec3

Return

Type: tuple(xIdx, zIdx)
def getWorldAABB(...): Return the bounding box of this NavMesh in world space.

Return

Type: tuple
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class NavObstacle

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var height: Obstacle height Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var radius: Obstacle radius. Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Navigable

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var recursive: Indicate whether the child meshes should be included or not. Type: bool. Default: True

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class OffMeshLink

Ancestors

Component

Instance variables

var areaId: OffMeshLink areaId. Type: int
var bidirectional: OffMeshLink bidirectional or unidirectional. Type: SceneObject
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var endpoint: OffMeshLink endpoint scene object, or uuid. Type: SceneObject or string
var mask: OffMeshLink mask. Type: int
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var radius: OffMeshLink radius. Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Particle

Ancestors

Component

Instance variables

var autoDrawing: Particle autoDrawing? Default: true. Type: bool
var color: Particle Color. Default: (1.0f, 1.0f, 1.0f, 1.0f) Type: Vec4
var dynamicParameter: Particle dynamic input parameter. Default: (0.0f, 0.0f, 0.0f, 0.0f) Type: Vec4
var enable: Enable/disable. Default: true. Type: bool
var groupMask: Particle group mask. Default: 0. Type: int
var loop: Should be looped? Default: false. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var path: Path to the .efk file. Type: string
var speed: Particle playing speed. Default: 1.0f Type: float
var targetLocation: Particle target location. Default: (0.0f, 0.0f, 0.0f) Type: Vec3
var timeScale: Particle playing time scale. Default: 1.0f Type: float

Methods

def isPaused(...): Check whether the particle is paused.
def isStopped(...): Check whether the particle is stopped.
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …
def pause(...): Pause particle.
def play(...): Play particle.
def resume(...): Resume particle.
def stop(...): Stop particle.

class ParticleManager

Ancestors

Component

Static methods

def getInstance(...): Get ParticleManager singleton instance.

ParticleManager.getInstance()

Return

Singleton instance of ParticleManager

Instance variables

var cullingLayerNumber: Culling layer number. Larger number produces more efficient culling, but it also uses a lot more of memory. Type: int Default: 4
var cullingWorldSize: Culling world size. Type: Vec3 Default: (1000, 1000, 1000)
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var enableCulling: Enable culling. Type: bool Default: True.
var maxParticleNumber: Max number of particles. Type: bool Default: 2000
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var threadNumber: Number of threads. Type: int Default: 1

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class PhysicConstraint

Subclasses

Dof6Constraint
FixedConstraint
HingeConstraint
SliderConstraint
SpringConstraint

Instance variables

var breakingImpulse: Breaking impulse threshold. Default: Very big number. Type: float
var isBodiesCollisionEnabled: Enable/disable collision between linked bodies. Default: true. Type: bool
var isEnabled: Enable/disable this constraint. Default: true. Type: bool
var other: The physic object that linked to this constraint. Type: Rigidbody
var owner: The physic object that own this constraint. Type: Rigidbody
var type: The type of the physic constraint. Type: int

class PhysicManager

Ancestors

Component

Static methods

def getInstance(...): Get PhysicManager singleton instance.

PhysicManager.getInstance()

Return

Singleton instance of PhysicManager

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var fixedTimeStep: Fixed time steps. Type: float
var frameMaxSubStep: Frame max simulation sub step. Type: int
var frameUpdateRatio: Frame update ratio (speedup/slower effects). Type: float
var gravity: Gravity. Type: Vec3
var name: Inherited from: Component.name

The name of the component. Type: string
var numIteration: Number of iteration. Type: int
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject

Methods

def clear(...): Clear the Physic world.

PhysicManager.getInstance().clear()
def contactPairTest(...): Perform contact test between pair of objects.

PhysicManager.getInstance().contactPairTest(collisionObjectA, collisionObjectB, group, mask)

Parameters

collisionObjectA: SceneObject, Rigidbody, or RidgidBody collisionObjectB: SceneObject, Rigidbody, or RidgidBody group: [int] Collision group mask: [int] Collision mask

Return: Tuple of (objectA: SceneObject, objectB: SceneObject, localPosA: Vec3, localPosB: Vec3, worldPosA: Vec3, worldPosB: Vec3, normalB: Vec3) as Tuple
def contactTest(...): Perform contact test.

PhysicManager.getInstance().contactTest(collisionObject, group, mask)

Parameters

collisionObject: SceneObject, Rigidbody, or RidgidBody group: [int] Collision group mask: [int] Collision mask

Return: Tuple of (objectA: SceneObject, objectB: SceneObject, localPosA: Vec3, localPosB: Vec3, worldPosA: Vec3, worldPosB: Vec3, normalB: Vec3) as Tuple
def isDeformable(...): Check if the world is deformable.

PhysicManager.getInstance().isDeformable()

Return: True/False
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …
def rayTestAll(...): Perform raytest to find all hit objects.

PhysicManager.getInstance().rayTestAll(from, to, group, mask)

Parameters

from: [Vec3] From vector to: [Vec3] To vector group: [int] Collision group mask: [int] Collision mask

Return: Tuple of (hitObject: SceneObject, hitPosition: Vec3, hitNormal: Vec3) as Tuple
def rayTestClosest(...): Perform raytest to find closest hit object.

PhysicManager.getInstance().rayTestClosest(from, to, group, mask)

Parameters

from: [Vec3] From vector to: [Vec3] To vector group: [int] Collision group mask: [int] Collision mask

Return

(hitObject: SceneObject, hitPosition: Vec3, hitNormal: Vec3) as Tuple, or None

class PointLight

Ancestors

Component

Instance variables

var color: Point Light Color. Type: Vec3
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var intensity: Point Light Intensity. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var position: Point Light Position. Type: Vec3
var range: Point Light Range. Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class RectTransform

Ancestors

Component

Instance variables

var anchor: Anchor. Type: Vec4
var anchorPosition: Return an attribute of instance, which is of type owner.
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var localPosition: Return an attribute of instance, which is of type owner.
var localRotation: Return an attribute of instance, which is of type owner.
var localScale: Return an attribute of instance, which is of type owner.
var name: Inherited from: Component.name

The name of the component. Type: string
var offset: Offset. Type: Vec4
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var pivot: Pivot. Type: Vec2
var position: Return an attribute of instance, which is of type owner.
var rect: Rect. Type: Vec4
var rotation: Return an attribute of instance, which is of type owner.
var scale: Return an attribute of instance, which is of type owner.
var size: Offset. Type: Vec4

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Rigidbody

Ancestors

Component

Subclasses

Softbody

Instance variables

var aabb: Is enabled. Type: bool
var activationState: Physic activation state. Type: int
var angularFactor: Angular Factor. Type: Vec3
var angularSleepingThreshold: Return an attribute of instance, which is of type owner.
var angularVelocity: Angular Velocity. Type: Vec3
var collisionGroup: Collision filter group. Type: int
var collisionMask: Collision filter mask. Type: int
var continuousDetection: Continuous Colision Detection. Type: bool
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var friction: Friction. Type: float
var isEnabled: Is enabled. Type: bool
var isKinematic: Is kinematic. Type: bool
var isTrigger: Is trigger. Type: bool
var linearFactor: Linear Factor. Type: Vec3
var linearSleepingThreshold: Return an attribute of instance, which is of type owner.
var linearVelocity: Linear Velocity. Type: Vec3
var mass: Mass. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var offset: Postion offset to adjust physic according to model in case the base position is not at the center of the model. Type: Vec3
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var restitution: Restitution. Type: float

Methods

def addConstraint(...)

Add constraint.

Parameters

type:
    int: Type of the constraint to be added.

constraint : PhysicConstraint
    Added constraint

def applyForce(...)

Apply force.

Parameters

force : Vec3
    force to apply
[Optional]position : Vec3
    Position to apply, or center

def applyImpulse(...)

Apply impulse.

Parameters

impulse : Vec3
    impulse to apply
[Opt]position : Vec3
    Position to apply, or center

def applyTorque(...)

Apply torque.

Parameters

torque : Vec3
    torque to apply

def applyTorqueImpulse(...)

Apply torque impulse.

Parameters

torque : Vec3
    torque to apply

def clearForces(...)

Clear all forces.

def getConstraints(...)

Get all constraints.

Return

constraints : tuple<PhysicConstraint>

def movePosition(...)

def moveRotation(...)

def onUpdate(...)

Inherited from: Component.onUpdate

Utility to force update component, eg transform …

def removeConstraint(...)

Add constraint.

Parameters

constraint:
    PhysicConstraint: constraint instance to remove.

Return

result : bool

def removeConstraints(...)

Remove all constraints.

Return

result: bool

class Scene (...)

Instance variables

var activeCamera: The current active camera. Type: CameraComponent
var name: Name of scene. Type: string
var root: [Readonly] The root object in the scene.

Methods

def capture(...)

Capture the current rendered scene to device storage as a PNG file. To capture whole scene, call Scene.capture() in onRenderUI(). To capture just 3D scene, call it in onRender(). Call the function else where like onUpdate, onClick, … will return false.

Scene().capture(file_name: string)

Parameters:

file_name: string
  Name of the file, without extension.

Return:

result: bool

def convertScreenPoint(...)

def createObject(...)

Create new scene object.

Scene().createObject(name: string, parent: SceneObject = None)

Parameters

name : string
    Name of the new scene object
parent : SceneObject
    Parent object

def findObject(...)

Find a object in the scene.

Scene().findObject(param: string|number)

Parameters

param : string
    UUID of the scene object to find
param : number (unsigned long long)
    ID of the scene object to find

Return:

SceneObject: if found
None: if not found

def findObjectByName(...)

Find a object in the scene.

Scene().findObject(param: string|number)

Parameters

param : string
    UUID of the scene object to find
param : number (unsigned long long)
    ID of the scene object to find

Return:

SceneObject: if found
None: if not found

def getEnvironment(...)

Get the associated environment instance.

Scene().getEnvironment()

Return:

Type: igeCore.environment

def getObjects(...)

Get the list of all objects in the scene.

Scene().getObjects()

Return:

Type: List<SceneObject>

def getPath(...)

Get the relative path to the scene file.

Scene().getPath()

Return:

Type: string

def getRoot(...)

Get the root object in the scene.

Scene().getRoot()

Return:

Type: SceneObject

def getScreenSize(...)

def getShowcase(...)

Get the associated showcase instance.

Scene().getShowcase()

Return:

Type: igeCore.showcase

def getViewSize(...)

def loadPrefab(...)

Create new scene object from prefab.

Scene().loadPrefab(path: string, name: string, parent: SceneObject = None)

Parameters

path : string
    Path to the prefab
name : string
    Name of the new scene object
parent : SceneObject
    Parent object

Return:

obj: SceneObject

def raycast(...)

Perform raycast to get the hit object and hit position.

Scene().raycast(origin: Vec3, direction: Vec3, distance: float)

Parameters:

origin: Vec3
  the ray's start point 
direction: Vec3
  the ray's direction
distance: float [Optional]
  Max distance. Default: 10000.f

Return:

Tuple: [object, position]

def raycastAll(...)

def raycastFromCamera(...)

Perform raycast to get the hit object and hit position.

Parameters:

screenPos: Vec2
  Screen position (2d screen space)
camera: pyxieCamera, CameraComponent, Camera SceneObject
  Camera to perform raycast
distance: float [Optional]
  Max distance. Default: 10000.f

Return:

Tuple: [object, position]

def raycastUI(...)

Perform raycast to get the hit object and hit position on UI layout.

Scene().raycastUI(screenPos: Vec2, camera: Camera, distance: float)

Parameters:

screenPos: Vec2
  Screen position (2d screen space)
camera: pyxieCamera, CameraComponent, Camera SceneObject
  Camera to perform raycast
distance: float [Optional]
  Max distance. Default: 10000.f

Return:

Tuple: [object, position]

def removeObject(...)

Remove object out of scene.

Scene().removeObject(param: string|number|SceneObject)

Parameters

param : string
    Name of the scene object to remove
param : number (unsigned long long)
    ID of the scene object to remove
param : SceneObject
    Scene object instance to remove

Return:

True: if removed success
False: if removed fail

def screenToWorldPoint(...)

def worldToScreenPoint(...)

class SceneManager

Static methods

def getInstance(...)

Get SceneManager singleton instance.

SceneManager.getInstance()

Return:

SceneManager:
    Singleton instance of SceneManager

Instance variables

var currentScene: Current activated scene. Type: Scene

Methods

def createScene(...)

Create new scene.

SceneManager.createScene(scene)

Parameters:

scene: string
    Name of the scene.

Return:

scene: Scene

def loadScene(...)

Load scene from file system.

SceneManager.loadScene(path)

Parameters:

path: string
    Path to the scene file in file system.

Return:

scene: Scene

def reloadScene(...)

Reload current scene.

SceneManager.reloadScene()

Return:

True:
    Success
False:
    Fail

def saveScene(...)

Save scene to file system.

SceneManager.saveScene(path)

Parameters:

path: string
    Path to save.

Return:

True:
    Success
False:
    Fail

def unloadScene(...)

Unload scene from memory.

SceneManager.unloadScene(scene)

Parameters:

scene: string
    scene name.
scene: Scene
    scene instance.

Return:

True:
    Success
False:
    Fail

class SceneObject

Instance variables

var active: The active status of the scene object. Type: boolean.
var id: The ID of the scene object. Type: number (unsigned long long).
var name: The ID of the scene object. Type: string.
var parent: The parent object of the object. Type: SceneObject.
var rectTransform: The transform component as RectTransform for UI elements. Type: RectTransform.
var scene: The scene the owner belong to. Type: Scene.
var selected: The selected status of the scene object. Type: boolean.
var transform: The transform component of the object. Type: TransformComponent.
var uuid: The UUID of the scene object. Type: string.

Methods

def addComponent(...)

Add a component to current scene object.

SceneObject().addComponent(param: string|Component)

Parameters

param : string
    Name of component to add
param : Component
    Instance of component to add

Return:

Component: if added
None: if not added

def findChildByName(...)

Get the list of all child objects from current scene object.

SceneObject().getChildren()

Return:

List of children objects

def getChildByIndex(...)

Get the child object by index.

SceneObject().getChildByIndex(index: int)

Parameters

index : int
    The index of the child object.

Return

child: SceneObject

def getChildIndex(...)

Get the index of child object.

SceneObject().getChildIndex(child: SceneObject|string)

Parameters

child : SceneObject|string
    Child object instance or it's UUID.

Return

index: int

def getChildren(...)

Get the list of all child objects from current scene object.

SceneObject().getChildren()

Return:

List of children objects

def getComponent(...)

Return an instance of component from current scene object.

SceneObject().getComponent(param: string)

Parameters

param : string
    Name of component to get

Return:

Component: if success
None: if fail

def getComponents(...)

Return a list of all components from current scene object.

SceneObject().getComponents()

Return:

List of all attached components

def getScene(...)

Get scene which contain the current object.

SceneObject().getScene()

Return

scene: Scene

def removeChildren(...)

Remove all children from current scene object.

SceneObject().removeChildren()

Return:

True: if removed
False: if not removed

def removeComponent(...)

Remove a component from current scene object.

SceneObject().removeComponent(param: string|Component)

Parameters

param : string
    Name of component to remove
param : Component
    Instance of component to remove

Return:

True: if remove
False: if not remove

def removeComponents(...)

Remove all components from current scene object.

SceneObject().getComponents()

Return:

True: if removed
False: if not removed

def setChildIndex(...)

Set the index of child object.

SceneObject().setChildIndex(child: SceneObject|string, index: int)

Parameters

child : SceneObject|string
    Child object instance or it's UUID.
index : int
    The index to be inserted as child.

Return

result: bool

class Script (*args, **kwargs)

Instance variables

var owner: Get the object owner. Type: SceneObject

class SliderConstraint

Ancestors

PhysicConstraint

Instance variables

var breakingImpulse: Inherited from: PhysicConstraint.breakingImpulse

Breaking impulse threshold. Default: Very big number. Type: float
var isBodiesCollisionEnabled: Inherited from: PhysicConstraint.isBodiesCollisionEnabled

Enable/disable collision between linked bodies. Default: true. Type: bool
var isEnabled: Inherited from: PhysicConstraint.isEnabled

Enable/disable this constraint. Default: true. Type: bool
var lowerLimit: Lower limit vector. Default (0.0, 0.0, 0.0). Type: Vec3
var other: Inherited from: PhysicConstraint.other

The physic object that linked to this constraint. Type: Rigidbody
var owner: Inherited from: PhysicConstraint.owner

The physic object that own this constraint. Type: Rigidbody
var type: Inherited from: PhysicConstraint.type

The type of the physic constraint. Type: int
var upperLimit: Upper limit vector. Default (0.0, 0.0, 0.0) Type: Vec3

class Softbody

Ancestors

Rigidbody
Component

Instance variables

var aabb: Inherited from: Rigidbody.aabb

Is enabled. Type: bool
var activationState: Inherited from: Rigidbody.activationState

Physic activation state. Type: int
var aeroModel: Aero model [0, 6]. 0: V_Point 1: V_TwoSided 2: V_TwoSidedLiftDrag 3: V_OneSided 4: F_TwoSided 5: F_TwoSidedLiftDrag 6: F_OneSided Default is 1. Type: int
var anchorHardness: Anchors hardness. Default is 1.0. Type: float
var angularFactor: Inherited from: Rigidbody.angularFactor

Angular Factor. Type: Vec3
var angularSleepingThreshold: Inherited from: Rigidbody.angularSleepingThreshold

Return an attribute of instance, which is of type owner.
var angularVelocity: Inherited from: Rigidbody.angularVelocity

Angular Velocity. Type: Vec3
var collisionGroup: Inherited from: Rigidbody.collisionGroup

Collision filter group. Type: int
var collisionMask: Inherited from: Rigidbody.collisionMask

Collision filter mask. Type: int
var continuousDetection: Inherited from: Rigidbody.continuousDetection

Continuous Colision Detection. Type: bool
var dampingCoeff: Damping Coefficient [0, 1]. Default is 1.0. Type: float
var dynamicFrictionCoeff: Dynamic friction coefficient [0, 1]. Default is 0.2. Type: float
var enable: Inherited from: Rigidbody.enable

Enable/disable this component. Type: bool
var friction: Inherited from: Rigidbody.friction

Friction. Type: float
var gravityFactor: Gravity factor. Default is 1.0. Type: float
var isEnabled: Inherited from: Rigidbody.isEnabled

Is enabled. Type: bool
var isKinematic: Inherited from: Rigidbody.isKinematic

Is kinematic. Type: bool
var isTrigger: Inherited from: Rigidbody.isTrigger

Is trigger. Type: bool
var kineticContactHardness: Kinetic contacts hardness. Default is 0.1. Type: float
var linearFactor: Inherited from: Rigidbody.linearFactor

Linear Factor. Type: Vec3
var linearSleepingThreshold: Inherited from: Rigidbody.linearSleepingThreshold

Return an attribute of instance, which is of type owner.
var linearStiffness: Linear stiffness coefficient [0, 1]. Default is 0.5 Type: float
var linearVelocity: Inherited from: Rigidbody.linearVelocity

Linear Velocity. Type: Vec3
var mass: Inherited from: Rigidbody.mass

Mass. Type: float
var name: Inherited from: Rigidbody.name

The name of the component. Type: string
var offset: Inherited from: Rigidbody.offset

Postion offset to adjust physic according to model in case the base position is not at the center of the model. Type: Vec3
var owner: Inherited from: Rigidbody.owner

The scene object that own this component. Type: SceneObject
var poseMatchCoeff: Pose matching coefficient [0, 1]. Default is 0. Type: float
var positionIterNumber: Position iteration number. Default is 1. Type: int
var pressureCoeff: Pressure coefficient [-inf, +inf]. Default is 0. Type: float
var restLengthScale: Rest Length Scale. Default is 1.0. Type: float
var restitution: Inherited from: Rigidbody.restitution

Restitution. Type: float
var rigidContactHardness: Rigid contacts hardness. Default is 1.0. Type: float
var selfCollision: Use Self Collision. Default is false. Type: bool
var sleepingThreshold: Sleeping Threshold. Default is 0.04. Type: float
var softCollision: Use soft soft-collision. Default is false. Type: bool
var softContactHardness: Soft contacts hardness. Default is 1.0. Type: float
var velocityFactor: Velocity correction factor. Default is 1.0. Type: float
var volumeConvCoeff: Volume conversation coefficient [0, +inf]. Default is 0. Type: float
var windVelocity: Wind Velocity. Default is (0, 0, 0) Type: Vec3

Methods

def addConstraint(...)

Inherited from: Rigidbody.addConstraint

Add constraint …

def addVelocity(...)

Add velocity to the body.

Parameters

velocity : Vec3
    Velocity to add
[Optional] nodeIdx : int
    Apply velocity just to the node with provided index.

Return

None

def appendAnchor(...)

Append anchor to the body.

Parameters

nodeIdx : int
    Node index
body : SceneObject, Rigidbody, or RigidBody
    Body to add as anchor
[Optional]disableLinkedColission : bool
    Disable Linked Colission or not. Default is false.
[Optional]influence : int
    influence factor. Default is 1.

Return

None

def appendDeformableAnchor(...)

Append deformable anchor to the body.

Parameters

nodeIdx : int
    Node index
body : SceneObject, Rigidbody, or RigidBody
    Body to add as anchor

Return

None

def applyForce(...)

Inherited from: Rigidbody.applyForce

Apply force …

def applyImpulse(...)

Inherited from: Rigidbody.applyImpulse

Apply impulse …

def applyRepulsionForce(...)

Apply repulsion force.

Parameters

timeStep : float
    Time step
applySpringForce : bool
    Whether spring force to apply

Return

None

def applyTorque(...)

Inherited from: Rigidbody.applyTorque

Apply torque …

def applyTorqueImpulse(...)

Inherited from: Rigidbody.applyTorqueImpulse

Apply torque impulse …

def clearForces(...)

Inherited from: Rigidbody.clearForces

Clear all forces.

def getCenterOfMass(...)

Get the body center of mass.

Return

centerOfMass : Vec3

def getConstraints(...)

Inherited from: Rigidbody.getConstraints

Get all constraints …

def getNearestNodeIndex(...)

Get nearest node index from a point in 3D coordination.

Parameters

position : Vec3
    Position

Return

nodeIdx : int

def getNodeNormal(...)

Get the normal of a node from node index.

Parameters

nodeIdx : int
    Node index

Return

normal : Vec3

def getNodePosition(...)

Get the position of a node from node index.

Parameters

nodeIdx : int
    Node index

Return

position : Vec3

def getVolume(...)

Get the volume of the body.

Return

volume : Vec3

def onUpdate(...)

Inherited from: Rigidbody.onUpdate

Utility to force update component, eg transform …

def removeAnchor(...)

Remove anchor from the body.

Parameters

nodeIdx : int
    Node index

Return

None

def removeConstraint(...)

Inherited from: Rigidbody.removeConstraint

Add constraint …

def removeConstraints(...)

Inherited from: Rigidbody.removeConstraints

Remove all constraints …

class SphereCollider

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var radius: The radius of the sphere. Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class SpotLight

Ancestors

Component

Instance variables

var angle: Spot Light Angle. Type: float
var color: Spot Light Color. Type: Vec3
var direction: Spot Light Direction. Type: Vec3
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var intensity: Spot Light Intensity. Type: float
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var position: Spot Light Position. Type: Vec3
var range: Spot Light Range. Type: float

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class SpringConstraint

Ancestors

PhysicConstraint

Instance variables

var breakingImpulse: Inherited from: PhysicConstraint.breakingImpulse

Breaking impulse threshold. Default: Very big number. Type: float
var damping: Damping vector. Default (0.5, 0.0, 0.0). Type: Vec3
var enable: Enable vector. Default (1.0, 0.0, 0.0). Type: Vec3
var isBodiesCollisionEnabled: Inherited from: PhysicConstraint.isBodiesCollisionEnabled

Enable/disable collision between linked bodies. Default: true. Type: bool
var isEnabled: Inherited from: PhysicConstraint.isEnabled

Enable/disable this constraint. Default: true. Type: bool
var lowerLimit: Lower limit vector. Default (0.0, 0.0, 0.0). Type: Vec3
var other: Inherited from: PhysicConstraint.other

The physic object that linked to this constraint. Type: Rigidbody
var owner: Inherited from: PhysicConstraint.owner

The physic object that own this constraint. Type: Rigidbody
var stiffness: Stiffness vector. Default (10.0, 0.0, 0.0). Type: Vec3
var type: Inherited from: PhysicConstraint.type

The type of the physic constraint. Type: int
var upperLimit: Upper limit vector. Default (0.0, 0.0, 0.0) Type: Vec3

class Sprite

Ancestors

Component

Subclasses

UIImage

Instance variables

var clockwise: Render clock wise. Type: bool
var color: Color. Type: Vec4
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var figure: Editable Figure instance (Read only). Type: EditableFigure
var fillAmount: Fill amount. Type: float
var fillMethod: Fill method: None = 0, Horizontal = 1, Vertical = 2, Radial90 = 3, Radial180 = 4, Radial360 = 5. Type: int
var fillOrigin: Fill origin: Bottom = 0, Top = 1, Left = 2, Right = 3, BottomLeft = 4, TopLeft = 5, TopRight = 6, BottomRight = 7. Type: int
var isBillboard: Render as billboard. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var path: Path to texture file. Type: string
var size: Size of sprite. Type: Vec2
var texture: Texture instance. Type: Texture

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Text

Ancestors

Component

Instance variables

var color: Color. Type: Vec4
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var fontPath: Font path. Type: String
var fontSize: Font size. Type: int
var isBillboard: Render as billboard. Type: bool
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var text: Text. Type: String

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class Transform

Ancestors

Component

Instance variables

var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var forward: Return an attribute of instance, which is of type owner.
var localForward: Return an attribute of instance, which is of type owner.
var localMatrix: Local transformation matrix. Type: Mat4
var localPosition: Position. Type: Vec3
var localRight: Return an attribute of instance, which is of type owner.
var localRotation: Rotation. Type: Quat
var localScale: Scale. Type: Vec3
var localUp: Return an attribute of instance, which is of type owner.
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var position: World Position. Type: Vec3
var right: Return an attribute of instance, which is of type owner.
var rotation: World Rotation. Type: Quat
var scale: World Scale. Type: Vec3
var up: Return an attribute of instance, which is of type owner.
var worldMatrix: World transformation matrix. Type: Mat4

Methods

def lookAt(...)
def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class UIButton

Ancestors

UIImage
Sprite
Component

Instance variables

var clockwise: Inherited from: UIImage.clockwise

Render clock wise. Type: bool
var color: Inherited from: UIImage.color

Color. Type: Vec4
var disableColor: Return an attribute of instance, which is of type owner.
var disableImage: Return an attribute of instance, which is of type owner.
var enable: Inherited from: UIImage.enable

Enable/disable this component. Type: bool
var fadeDuration: Return an attribute of instance, which is of type owner.
var figure: Inherited from: UIImage.figure

Editable Figure instance (Read only). Type: EditableFigure
var fillAmount: Inherited from: UIImage.fillAmount

Fill amount. Type: float
var fillMethod: Inherited from: UIImage.fillMethod

Fill method: None = 0, Horizontal = 1, Vertical = 2, Radial90 = 3, Radial180 = 4, Radial360 = 5. Type: int
var fillOrigin: Inherited from: UIImage.fillOrigin

Fill origin: Bottom = 0, Top = 1, Left = 2, Right = 3, BottomLeft = 4, TopLeft = 5, TopRight = 6, BottomRight = 7. Type: int
var image: Inherited from: UIImage.image

Return an attribute of instance, which is of type owner.
var interactable: Inherited from: UIImage.interactable

Return an attribute of instance, which is of type owner.
var isBillboard: Inherited from: UIImage.isBillboard

Render as billboard. Type: bool
var name: Inherited from: UIImage.name

The name of the component. Type: string
var owner: Inherited from: UIImage.owner

The scene object that own this component. Type: SceneObject
var path: Inherited from: UIImage.path

Path to texture file. Type: string
var pressColor: Return an attribute of instance, which is of type owner.
var pressImage: Return an attribute of instance, which is of type owner.
var selectedColor: Return an attribute of instance, which is of type owner.
var selectedImage: Return an attribute of instance, which is of type owner.
var size: Inherited from: UIImage.size

Size of sprite. Type: Vec2
var texture: Inherited from: UIImage.texture

Texture instance. Type: Texture
var transitionMode: Return an attribute of instance, which is of type owner.

Methods

def onUpdate(...): Inherited from: UIImage.onUpdate

Utility to force update component, eg transform …

class UIImage

Ancestors

Sprite
Component

Subclasses

UIButton
UIMask
UIScrollBar
UIScrollView

Instance variables

var clockwise: Inherited from: Sprite.clockwise

Render clock wise. Type: bool
var color: Inherited from: Sprite.color

Color. Type: Vec4
var enable: Inherited from: Sprite.enable

Enable/disable this component. Type: bool
var figure: Inherited from: Sprite.figure

Editable Figure instance (Read only). Type: EditableFigure
var fillAmount: Inherited from: Sprite.fillAmount

Fill amount. Type: float
var fillMethod: Inherited from: Sprite.fillMethod

Fill method: None = 0, Horizontal = 1, Vertical = 2, Radial90 = 3, Radial180 = 4, Radial360 = 5. Type: int
var fillOrigin: Inherited from: Sprite.fillOrigin

Fill origin: Bottom = 0, Top = 1, Left = 2, Right = 3, BottomLeft = 4, TopLeft = 5, TopRight = 6, BottomRight = 7. Type: int
var image: Return an attribute of instance, which is of type owner.
var interactable: Return an attribute of instance, which is of type owner.
var isBillboard: Inherited from: Sprite.isBillboard

Render as billboard. Type: bool
var name: Inherited from: Sprite.name

The name of the component. Type: string
var owner: Inherited from: Sprite.owner

The scene object that own this component. Type: SceneObject
var path: Inherited from: Sprite.path

Path to texture file. Type: string
var size: Inherited from: Sprite.size

Size of sprite. Type: Vec2
var texture: Inherited from: Sprite.texture

Texture instance. Type: Texture

Methods

def onUpdate(...): Inherited from: Sprite.onUpdate

Utility to force update component, eg transform …

class UIMask

Ancestors

UIImage
Sprite
Component

Instance variables

var clockwise: Inherited from: UIImage.clockwise

Render clock wise. Type: bool
var color: Inherited from: UIImage.color

Color. Type: Vec4
var enable: Inherited from: UIImage.enable

Enable/disable this component. Type: bool
var figure: Inherited from: UIImage.figure

Editable Figure instance (Read only). Type: EditableFigure
var fillAmount: Inherited from: UIImage.fillAmount

Fill amount. Type: float
var fillMethod: Inherited from: UIImage.fillMethod

Fill method: None = 0, Horizontal = 1, Vertical = 2, Radial90 = 3, Radial180 = 4, Radial360 = 5. Type: int
var fillOrigin: Inherited from: UIImage.fillOrigin

Fill origin: Bottom = 0, Top = 1, Left = 2, Right = 3, BottomLeft = 4, TopLeft = 5, TopRight = 6, BottomRight = 7. Type: int
var image: Inherited from: UIImage.image

Return an attribute of instance, which is of type owner.
var interactable: Inherited from: UIImage.interactable

Return an attribute of instance, which is of type owner.
var isBillboard: Inherited from: UIImage.isBillboard

Render as billboard. Type: bool
var name: Inherited from: UIImage.name

The name of the component. Type: string
var owner: Inherited from: UIImage.owner

The scene object that own this component. Type: SceneObject
var path: Inherited from: UIImage.path

Path to texture file. Type: string
var size: Inherited from: UIImage.size

Size of sprite. Type: Vec2
var texture: Inherited from: UIImage.texture

Texture instance. Type: Texture
var useMask: Return an attribute of instance, which is of type owner.

Methods

def onUpdate(...): Inherited from: UIImage.onUpdate

Utility to force update component, eg transform …

class UIScrollBar

Ancestors

UIImage
Sprite
Component

Instance variables

var clockwise: Inherited from: UIImage.clockwise

Render clock wise. Type: bool
var color: Inherited from: UIImage.color

Color. Type: Vec4
var direction: Return an attribute of instance, which is of type owner.
var disableColor: Return an attribute of instance, which is of type owner.
var enable: Inherited from: UIImage.enable

Enable/disable this component. Type: bool
var fadeDuration: Return an attribute of instance, which is of type owner.
var figure: Inherited from: UIImage.figure

Editable Figure instance (Read only). Type: EditableFigure
var fillAmount: Inherited from: UIImage.fillAmount

Fill amount. Type: float
var fillMethod: Inherited from: UIImage.fillMethod

Fill method: None = 0, Horizontal = 1, Vertical = 2, Radial90 = 3, Radial180 = 4, Radial360 = 5. Type: int
var fillOrigin: Inherited from: UIImage.fillOrigin

Fill origin: Bottom = 0, Top = 1, Left = 2, Right = 3, BottomLeft = 4, TopLeft = 5, TopRight = 6, BottomRight = 7. Type: int
var image: Inherited from: UIImage.image

Return an attribute of instance, which is of type owner.
var interactable: Inherited from: UIImage.interactable

Return an attribute of instance, which is of type owner.
var isBillboard: Inherited from: UIImage.isBillboard

Render as billboard. Type: bool
var name: Inherited from: UIImage.name

The name of the component. Type: string
var owner: Inherited from: UIImage.owner

The scene object that own this component. Type: SceneObject
var path: Inherited from: UIImage.path

Path to texture file. Type: string
var pressColor: Return an attribute of instance, which is of type owner.
var size: Inherited from: UIImage.size

Size of sprite. Type: Vec2
var texture: Inherited from: UIImage.texture

Texture instance. Type: Texture
var value: Return an attribute of instance, which is of type owner.

Methods

def onUpdate(...): Inherited from: UIImage.onUpdate

Utility to force update component, eg transform …
def setHandle(...)

class UIScrollView

Ancestors

UIImage
Sprite
Component

Instance variables

var clockwise: Inherited from: UIImage.clockwise

Render clock wise. Type: bool
var color: Inherited from: UIImage.color

Color. Type: Vec4
var enable: Inherited from: UIImage.enable

Enable/disable this component. Type: bool
var figure: Inherited from: UIImage.figure

Editable Figure instance (Read only). Type: EditableFigure
var fillAmount: Inherited from: UIImage.fillAmount

Fill amount. Type: float
var fillMethod: Inherited from: UIImage.fillMethod

Fill method: None = 0, Horizontal = 1, Vertical = 2, Radial90 = 3, Radial180 = 4, Radial360 = 5. Type: int
var fillOrigin: Inherited from: UIImage.fillOrigin

Fill origin: Bottom = 0, Top = 1, Left = 2, Right = 3, BottomLeft = 4, TopLeft = 5, TopRight = 6, BottomRight = 7. Type: int
var image: Inherited from: UIImage.image

Return an attribute of instance, which is of type owner.
var interactable: Inherited from: UIImage.interactable

Return an attribute of instance, which is of type owner.
var isBillboard: Inherited from: UIImage.isBillboard

Render as billboard. Type: bool
var name: Inherited from: UIImage.name

The name of the component. Type: string
var owner: Inherited from: UIImage.owner

The scene object that own this component. Type: SceneObject
var path: Inherited from: UIImage.path

Path to texture file. Type: string
var size: Inherited from: UIImage.size

Size of sprite. Type: Vec2
var texture: Inherited from: UIImage.texture

Texture instance. Type: Texture

Methods

def onUpdate(...): Inherited from: UIImage.onUpdate

Utility to force update component, eg transform …

class UISlider

Ancestors

Component

Instance variables

var color: Return an attribute of instance, which is of type owner.
var direction: Return an attribute of instance, which is of type owner.
var disableColor: Return an attribute of instance, which is of type owner.
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var fadeDuration: Return an attribute of instance, which is of type owner.
var interactable: Return an attribute of instance, which is of type owner.
var max: Return an attribute of instance, which is of type owner.
var min: Return an attribute of instance, which is of type owner.
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var pressColor: Return an attribute of instance, which is of type owner.
var value: Return an attribute of instance, which is of type owner.
var wholeNumbers: Return an attribute of instance, which is of type owner.

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …
def setFill(...)
def setHandle(...)

class UIText

Ancestors

Component

Subclasses

UITextField

Instance variables

var color: Color. Type: Vec4
var enable: Inherited from: Component.enable

Enable/disable this component. Type: bool
var fontPath: Font path. Type: String
var fontSize: Font size. Type: int
var name: Inherited from: Component.name

The name of the component. Type: string
var owner: Inherited from: Component.owner

The scene object that own this component. Type: SceneObject
var text: Text. Type: String

Methods

def onUpdate(...): Inherited from: Component.onUpdate

Utility to force update component, eg transform …

class UITextField

Ancestors

UIText
Component

Instance variables

var color: Inherited from: UIText.color

Color. Type: Vec4
var enable: Inherited from: UIText.enable

Enable/disable this component. Type: bool
var fontPath: Inherited from: UIText.fontPath

Font path. Type: String
var fontSize: Inherited from: UIText.fontSize

Font size. Type: int
var name: Inherited from: UIText.name

The name of the component. Type: string
var owner: Inherited from: UIText.owner

The scene object that own this component. Type: SceneObject
var text: Inherited from: UIText.text

Text. Type: String

Methods

def onUpdate(...): Inherited from: UIText.onUpdate

Utility to force update component, eg transform …