PLUG'N SCRIPT
rapid plugin development
Tutorial
DSP
KUIML
How-to
Scripts
  • Overview
  • Tutorial
  • Reference
Layout and positioning
  • CELL
  • TABLE
Language basics
  • SKIN
  • DUMMY
  • INCLUDE
  • INCLUDE_ONCE
  • DEFINE
  • UNDEFINE
  • VARIABLE
  • LOCAL_VARIABLE
  • TEMPLATE
  • TEMPLATE_INNER_CONTENT
  • TEMPLATE_UNLOAD
  • REPEAT
Text widgets
  • TEXT
  • TEXT_FIELD
  • TEXT_EDIT_BOX
  • TOOLTIP
  • PARAM_TEXT
  • PARAM_TEXT_CONTROL
  • PARAM_TEXT_EDIT_BOX
  • PARAM_TOOLTIP
Image widgets
  • IMAGE
  • IMAGE_ACTION_BUTTON
  • IMAGE_GROUP_BOX
  • IMAGE_PARAM_BUTTON
  • IMAGE_PARAM_KNOB
  • IMAGE_PARAM_LINEAR_METER
  • IMAGE_PARAM_MENU_BUTTON
  • IMAGE_PARAM_METER
  • IMAGE_PARAM_SLIDER
  • IMAGE_PARAM_TOGGLE_SWITCH
  • XYZ_IMAGE_PARAM_JOYSTICK
Invisible controls
  • INVISIBLE_ACTION_BUTTON
  • INVISIBLE_PARAM_BUTTON
  • INVISIBLE_PARAM_KNOB
  • INVISIBLE_PARAM_MENU_BUTTON
  • INVISIBLE_PARAM_SLIDER
  • INVISIBLE_PARAM_TOGGLE_SWITCH
  • XY_PARAM_PAD
  • XY_ZOOM_SELECT_PAD
  • XYZ_PARAM_SCRATCH_PAD
  • XYZ_PARAM_CLICK_PAD
Drawing, curves & 3D
  • CANVAS
    • Graphics API
  • svg
  • CURVE_GRAPH
  • XY_CURVES_GRAPH
  • GRID
  • RULER
  • COLOR_SCALE
  • VIEW_3D
  • COLOR_SURFACE_3D
  • GRID_3D
  • GL_OBJECT_3D
    • OpenGL Cheat Sheet
  • SURFACE_COLORMAP_2DPLOT
Miscellaneous
  • SCRIPT
  • WIDGET
  • KUIML_WIDGET
  • POPUP_MENU
  • MENU_ITEM
  • MENU_SEPARATOR
  • FILE_SELECT_MENU
  • SYSTEM_ACTION_BUTTON
  • SYSTEM_PARAM_CHECKBOX
  • SYSTEM_PARAM_DROPDOWN_LIST
  • WINDOW
  • LOAD_FONT
Data model
  • STRING
  • PARAM
  • FORMULA_PARAM
  • PARAM_ANIMATOR
  • ACTION
    • Built-in action types
  • TIMER
  • ACTION_TRIGGER
  • CURVE
  • FORMULA_CURVE
  • CURVE_FROM_PARAM_OVER_TIME
  • SURFACE
  • FORMULA_SURFACE
  • SURFACE_FROM_CURVE_OVER_TIME
  • GROUP
Links and commands
  • PARAM_LINK
  • PARAM_MULTI_LINK
  • PARAM_CONNECTION
  • PARAM_TO_STRING_LINK
  • STRING_LINK
  • STRING_MULTI_LINK
  • CURVE_LINK
  • CURVE_MULTI_LINK
  • SURFACE_LINK
  • REQUIRED_OBJECTS
  • EXPOSED_OBJECTS
  • PERSISTENT_OBJECTS
Common attrubutes
  • For all elements
  • Widgets
  • Param Widgets
  • Param Controls
  • Param Info Viewers
  • Text Widgets
  • Surface Viewers
  • Curve Viewers
  • Images
  • 3D Objects
Additional information
  • All attributes
  • Attribute types
  • Cursors
  • Math formulas
  • Scripting
    • Built-in addons
  • User experience
  • Errors and solutions
  • Built-in variables
  • Runtime model
  • Parameters mapping
  • Script converter
  • LetiMix
KUIMLReferenceFORMULA_SURFACE
August 21, 2025

FORMULA_SURFACE

This element creates a surface defined by a mathematical formula (z=f(x,y)).

Attributes brief detailed show all inherited

Name DescriptionDefault
formulaMathematical formula for the curveThe formula can reference any parameter, curve or surface available in the skinempty
x_variablename of the "x" variable in the formulaYou can customize the name of the traditional "x" variable in z=f(x,y) formula so that it becomes z=f(variable,y)x
y_variablename of the "y" variable in the formulaYou can customize the name of the traditional "y" variable in z=f(x,y) formula so that it becomes z=f(x,variable)y
Events
Exposed: v. 2.0value_changedthe event is triggered anytime the value of the object has changed
Common attributesRead about `common`
idIdentifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.empty
Name Value type Default Description Comment
formulaMath FormulaemptyMathematical formula for the curveThe formula can reference any parameter, curve or surface available in the skin
x_variablestringxname of the "x" variable in the formulaYou can customize the name of the traditional "x" variable in z=f(x,y) formula so that it becomes z=f(variable,y)
y_variablestringyname of the "y" variable in the formulaYou can customize the name of the traditional "y" variable in z=f(x,y) formula so that it becomes z=f(x,variable)
Events
Exposed: v. 2.0value_changedeventthe event is triggered anytime the value of the object has changed
Common attributesRead about `common`
ididentifieremptyIdentifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.

Examples

The code below creates a surface that is displayed on a 3D graph. 

  1. <!-- The formula that defines the surface -->
  2. <FORMULA_SURFACE id="demo_surface" formula="tanh(y)*tanh(x*3)" x_min="-2" x_max="2" x_default="0" y_min="-2" y_max="2" y_default="0" z_min="-1" z_max="1" z_default="0"/>

  3. <!-- The 3D Viewer -->
  4. <VIEW_3D id="my_3d_view" width="400" height="250" x_ratio="1" y_ratio="0.8" z_ratio="0.8" transform.tx="0.02" transform.ty="0.02" transform.tz="-1.6" transform.rx="30" transform.ry="0" transform.rz="40" cursor="system::open_hand" persistent_viewpoint="false">

  5. <!-- Grid object -->
  6. <GRID_3D id="my_3d_view.grid" x_param_info_id="demo_surface.x_info" y_param_info_id="demo_surface.y_info" z_param_info_id="demo_surface.z_info" y_positions_count="11" x_positions_count="11" z_positions_count="11" x_position="-0.5" y_position="-0.5" z_position="-0.5" opacity="0.4" />

  7. <!-- The Color surface-->
  8. <COLOR_SURFACE_3D id="my_3d_view.surface" surface_id="demo_surface" visible="true" draw_style="solid" high_color="#ff0000" low_color="#000030" opacity=".8" x_positions_count="100" y_positions_count="100" x_position="-.5" y_position="-.5" z_position="-.5"/>
  9. </VIEW_3D>

Related elements

Also see GL_OBJECT_3D, GRID_3D, VIEW_3D.


Comments

Please, authorize to view and post comments.

2020 - 2025 © Site by LetiMix · Donate  |  Plug'n Script and KUIML by Blue Cat Audio