Documentation/Entity Types/Base/MapCurve.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Contents

Description

MapCurve.type allows you to create a motion path on the map, using control points. The level developer can use it for any purpose. A usage example of the motion path on the map is the MapCameraCurve.type type. With it, we set the motion path of the camera flight.

MapCurve 01.jpg

Creation

To put the motion path on the map, you need to add a MapCurve.type object. Then, pre-selecting the object you have just created, you need to add the rest of the points using the button "Add point", under the properties window.

The key point is defined by the MapCurvePoint type. A new point is added after the selected one. For example, if you have two points and want to create a third one between them, then select the first point and click the "Add point". Also you can change the order of points using the Time parameter.

MapCurve 02.jpg

Properties

Properties MapCurve

The special properties of the MapCurve object are divided into two groups: "class MapCurve" and "class MapCurvePoint".

Name Description
class Entity
Components List of attached components.
LogicClass Reference to the Logic Editor class. Read more about how to work with the Logic Editor class.
Name Object name.
Tags User defined information. Defined as keyvalue pairs. It is used for user's needs.
Type Object type. It can not be changed.
class MapCurve
AutomaticTimeStep Modifies the Time parameters of key points (see MapCurvePoint properties). If 0 is specified, automatic calculation is turned off, and Time must be set manually.
CurveType Type of the curve. You can choose from UniformCubicSpline (cubic splines) and Bezier (Bezier curves).
class MapCurvePoint
Owner Defines the curve this point belongs to.
Time Defines the time at which we will be at this point. Changing the Time between points will modify their order.
class MapObject
Position Object position on the map.
Rotation Object rotation. The angle of rotation is set in degrees.
Scale Object scaling.
Map Editor
AutoVerticalAlignment Automatical alignment by height mode. Allows to set the value among 4 variants: None (without alignment ), ByBounds (by dimensions), ByBoundsWithRotation (by dimension with possible rotation), ByCenter (by center).
Layer The layer of the map these objects belong to.

Properties of MapCurvePoint

The special properties of the MapCurvePoint object are in the "class MapCurvePoint" group.

Name Description
class Entity
Components List of attached components.
LogicClass Reference to the Logic Editor class. Read more about how to work with the Logic Editor class.
Name Object name.
Tags User defined information. Defined as keyvalue pairs. It is used for user's needs.
Type Object type. It can not be changed.
class MapCurvePoint
Owner Defines the curve this point belongs to.
Time Defines the time at which we will be at this point. Changing the Time between points will modify their order.
class MapObject
Position Object position on the map.
Rotation Object rotation. The angle of rotation is set in degrees.
Scale Object scaling.
Map Editor
AutoVerticalAlignment Automatical alignment by height mode. Allows to set the value among 4 variants: None (without alignment ), ByBounds (by dimensions), ByBoundsWithRotation (by dimension with possible rotation), ByCenter (by center).
Layer The layer of the map these objects belong to.