Overview
VSAR provides a set of procedural primitives. Procedural primitives, as opposed to static elements, are customizable and can be modified at runtime, which can be useful for dynamic geometries such as bar charts, pie charts and so on.
List of Primitives
Cone
A beveled cone. Top vertex can be beveled as well. It is a component of the arrow.
Cylinder
This is the base for Pie charts. Many configurations are possible, including cylinders with holes.
Arrow
An beveled Arrow composed of a Cone and a Parametric Curve 2D (parabola).
Moebius Strip
Möbius loop is a surface that can be formed by attaching the ends of a strip of paper together with a half-twist.
Box
A simple beveled box.
Torus
A Torus.
Sphere
An ellipsoid displayed with triangles (aka icosphere).
Disk
A flat, simple disk.
Text
A Text renderer.
|
Note |
|
There is currently no format control (example: Fit in a box, …). Input is html ( supported subset of html), so we can set modifiers inside the text (eg: Bold, Italic, Font change, Font size change, …). Currently supports multiple line text (by using <br> tag). |
📝 Alternative is provided by Unreal Engine called “Text3D” (it is considered experimal), it is component that can be added to actors.
| See the to Camio 2D/3D Text Component section, if text transition is needed, for text with transition out of the box. |
Usage
A primitive is represented by a Component object in the Unreal Editor. Multiple Components can be attached to an Actor object (example: a pie chart would be composed of multiple MtCylinder components). The Component inherits the parent Actor’s transformation in addition to its own transformation (Location, Rotation, Scale).
Each primitive exposes a set of properties that the user can get/set in real time with the Editor UI or Lua scripts.
The property center location is common to all primitives and defines the normalized coordinates of the primitive’s anchor point in 3D space.
For example, a “bottom-center location” anchor point for a box would be equal to a value of (0,0,-0.5).
Unreal Editor
Add a Component to an Actor.
- Tip: The user can search for the Component in the search bar (example, MtBox, MtCylinder, etc.).
Edit the properties in the Details Panel.
|
See the Video examples. |
Lua Scripting
|
For info about LUA commands, see the PRIME VSAR API Guide. |