TorqueScript Reference
GuiEditParticleColorGraph Class Reference

#include <guiEditParticleColorGraph_ScriptBinding.h>

Inherits GuiParticleGraphInspector.

Public Member Functions

String getActiveChannel ()
String getColorAtTime (time)
String getGradientStops ()
void setActiveChannel (channel)
void setStripHeight (height)
Public Member Functions inherited from GuiParticleGraphInspector
String getDisplayField ()"
Integer getEmitterIndex ()"
void inspect (ParticleAsset)"
void setDisplayArea (area(xMin/yMin/xMax/yMax))"
void setDisplayField (FieldName, [EmitterIndex])"
void setDisplayLabels (LabelX, LabelY)"
void setVariationGraphInspector (inspector)"
Public Member Functions inherited from GuiControl
void addGuiControl (int controlId)
void applySizing ()
Boolean canBeChildOf (GuiControl parent)
void childrenReordered ()
Integer findHitControl (int x, int y)
String getCenter ()
String getExtent (...)
String getGlobalCenter ()
String getGlobalPosition ()
String getMinExtent ()
Integer getParent ()
String getPosition ()
String getText ()
Boolean getTextExtend ()
Boolean getTextWrap ()
String getValue ()
Boolean isActive ()
Boolean isAwake ()
Boolean isGeometryEditable ()
Boolean isVisible ()
void makeFirstResponder (isFirst)
void performClick ()
Boolean pointInControl (int x, int y)
Boolean pullIntoView ()
Boolean rendersChildren ()
void reorderChild (child1, child2)
void resize (int x, int y, int w, int h)
void setActive (isActive)
void setCanSave (bool canSave)
void setCenter (int x, int y)
void setExtent (int width, int height)
void setFirstResponder ()
void setPosition (int x, int y)
void setPositionGlobal (int x, int y)
void setProfile (GuiControlProfile p)
void setText (text)
void setTextExtend (setting)
void setTextID (id)
void setTextWrap (setting)
void setValue (value)
void setVisible (isVisible)

Member Function Documentation

◆ getActiveChannel()

String getActiveChannel ( )

Gets which color channel the graph is editing.

Returns
Red, Green or Blue.

◆ getColorAtTime()

String getColorAtTime ( time )

Gets the color the three channels mix to at a point in the particle's life. This is the color the strip under the plot is drawing at that time.

Parameters
timeWhere in the particle's life to sample, from 0 to 1.
Returns
The color as "red green blue", each from 0 to 1.

◆ getGradientStops()

String getGradientStops ( )

Gets the times the mixed color strip bends at, across the visible time window. Every key of every channel inside the window, plus the window's two edges.

Returns
A space separated list of times.

◆ setActiveChannel()

void setActiveChannel ( channel )

Sets which color channel the graph edits. The other two channels stay on screen, drawn dim, and a click cannot reach them.

Parameters
channelRed, Green or Blue. The field names RedChannel, GreenChannel and BlueChannel are accepted too.
Returns
No return value.

◆ setStripHeight()

void setStripHeight ( height )

Sets how tall the mixed color strip under the plot is drawn.

Parameters
heightThe height in pixels, or zero for no strip at all.
Returns
No return value.