GuiParticleGraphInspector Class Reference

#include <guiParticleGraphInspector_ScriptBinding.h>

Inherits GuiControl.

Inherited by GuiEditParticleColorGraph.

Public Member Functions
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

getDisplayField()

String getDisplayField

(

)

Gets the name of the particle field the graph is showing.

Returns

The field name.

getEmitterIndex()

Integer getEmitterIndex

(

)

Gets the index of the emitter the graph is reading its field from. Meaningless for an asset level field, which no emitter owns.

Returns

The emitter index.

inspect()

void inspect

(

ParticleAsset

)

Sets the Particle Asset that will be used to draw graphs.

Parameters

ParticleAsset

The target of the graphs.

Returns

No return value.

setDisplayArea()

void setDisplayArea

(

area(xMin/yMin/xMax/yMax)

)

Sets the area that will be displayed on the graph.

Parameters

Area	Four space-deliminated values representing left, bottom, right, top.

Returns

No return value.

setDisplayField()

void setDisplayField

(

FieldName

)

Sets the graph field to display.

Parameters

FieldName	The name of the field that should be displayed.
EmitterIndex	If the field belongs to an emitter, include the index of the emitter to display.

Returns

No return value.

setDisplayLabels()

void setDisplayLabels	(	LabelX	,
		LabelY	)

Sets the labels to display on the graph.

Parameters

LabelX	The label that appears on the bottom of the graph.
LabelY	The label that appears on the left of the graph.

Returns

No return value.

setVariationGraphInspector()

void setVariationGraphInspector

(

inspector

)

Sets the graph inspector to use to show variance.

Parameters

Inspector

The GuiParticleGraphInspector that is tracking the variation.

Returns

No return value.