Documentation/Entity Types/Base/RenderableCurve.type

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Contents

Description

RenderableCurve.type allows placing on the map curves with custom width, color and other settings. To paint the curve you can apply various materials with specific textures and transaprency. This object is used for a number of purposes. For instance, you can create wires, pipes or ropes.

RenderableCurve 01.jpg

Creation

To create this object, select the RenderableCurve object in the Object Creation window, in the Types\Special\RenderableCurve folder. Then, add the object to the map by left-clicking anywhere in a work space of the window.

RenderableCurve 02.jpg

Before you can configure the curve, you should select it in the Objects window.

RenderableCurve 03.jpg

Aside from the object itself, there are 3 more buttons in the Properties window:

  • AddPoint — add a point,
  • Select All Points — select all points,
  • Clone — create a copy of the object.
RenderableCurve 04.jpg

Points make up the curve. To add one more point beyond the first one, select the curve in the work space or in the Objects window and click the Add Point button. Further, when you click Add Point, new points are added after the currently selected point. You can remove curve points just like any other object — by pressing the Delete key or clicking the corresponding button on the toolbar.

You can move and rotate points the same way as all other objects on the map. Use transformation tools for that.

RenderableCurve 06.jpg

Properties

RenderableCurve properties

Special properties of a RenderableCurve type object are in the "class RenderableCurve" group.

Title 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 MapObject
Position Object position on the map.
Rotation Object rotation. The angle of rotation is set in degrees.
Scale Object scaling.
class RenderableCurve
MaterialName The name of material the curve is painted with.
PathSteps The number of sections between two points of the curve. The higher this value is, the smoother the curve looks. At the same time, significant number of sections leads to increased curve rendering time. To create a poly-line, set this parameter to 1.
Radius The radius that sets the width of the curve.
ShapeSegments The number of segments in the curve profile. The higher this value is, the smoother curve profile looks. With this parameter you can adjust the form of a profile varying it from a polygon to a circle. More profile segments increases curve rendering time. The minimum number of segments in the profile is 2.
TextureCoordinatesTilePerMeter Texture coordinates zoom factor. The higher this value is, the more often the texture repeats.
Map Editor
AutoVerticalAlignment Automatic vertical alignment mode. You can choose between four options: None (no vertical alignment), ByBounds (dimension-based vertical alignment), ByBoundsWithRotation (dimension-based alignment plus possible rotation), ByCenter (centered alignment).
Layer A layer of the map the given object belongs to.

RenderableCurvePoint properties

A RenderableCurvePoint object type lacks any special properties.

Title 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 The curve the given point belongs to.
Time The moment of time we've got to be in this point. By varying the Time property of two point you can change 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.