Torque2D Reference
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Protected Member Functions | List of all members
SceneWindow Class Reference

#include <SceneWindow.h>

+ Inheritance diagram for SceneWindow:

Classes

struct  CameraView
 Camera View. More...
 

Public Types

enum  CameraInterpolationMode { INVALID_INTERPOLATION_MODE , LINEAR , SIGMOID }
 Camera Interpolation Mode. More...
 
- Public Types inherited from GuiControl
enum  horizSizingOptions {
  horizResizeRight = 0 , horizResizeWidth , horizResizeLeft , horizResizeCenter ,
  horizResizeRelative , horizResizeFill
}
 
enum  vertSizingOptions {
  vertResizeBottom = 0 , vertResizeHeight , vertResizeTop , vertResizeCenter ,
  vertResizeRelative , vertResizeFill
}
 
enum  TextRotationOptions { tRotateNone = 0 , tRotateLeft , tRotateRight }
 
- Public Types inherited from SimSet
typedef SimObjectList::iterator iterator
 
typedef SimObjectList::value_type value
 
- Public Types inherited from SimObject
enum  WriteFlags { SelectedOnly = BIT(0) }
 

Public Member Functions

virtual bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
 
virtual void onSleep ()
 Called when this object is asked to sleep.
 
virtual void setControlThumbProfile (GuiControlProfile *prof)
 
virtual void setControlTrackProfile (GuiControlProfile *prof)
 
virtual void setControlArrowProfile (GuiControlProfile *prof)
 
 SceneWindow ()
 
virtual ~SceneWindow ()
 
virtual bool onAdd ()
 Called when this object is added to the scene.
 
virtual void onRemove ()
 Called when this object is removed using delete.
 
virtual void setScene (Scene *pScene)
 Initialization.
 
virtual void resetScene (void)
 
void setRenderGroups (const U32 groupMask)
 
void setRenderLayers (const U32 layerMask)
 
void setRenderMasks (const U32 layerMask, const U32 groupMask)
 
U32 getRenderLayerMask (void)
 
U32 getRenderGroupMask (void)
 
ScenegetScene (void) const
 Get scene.
 
void setLockMouse (bool lockStatus)
 Mouse.
 
bool getLockMouse (void)
 
Vector2 getMousePosition (void)
 
void setMousePosition (const Vector2 &mousePosition)
 
void setBackgroundColor (const ColorF &backgroundColor)
 Background color.
 
const ColorFgetBackgroundColor (void) const
 
void setUseBackgroundColor (const bool useBackgroundColor)
 
bool getUseBackgroundColor (void) const
 
void setObjectInputEventFilter (const U32 groupMask, const U32 layerMask, const bool useInvisible=false)
 Input.
 
void setObjectInputEventGroupFilter (const U32 groupMask)
 
void setObjectInputEventLayerFilter (const U32 layerMask)
 
void setObjectInputEventInvisibleFilter (const bool useInvisible)
 
void setUseWindowInputEvents (const bool inputStatus)
 
void setUseObjectInputEvents (const bool inputStatus)
 
bool getUseWindowInputEvents (void) const
 
bool getUseObjectInputEvents (void) const
 
void clearWatchedInputEvents (void)
 
void removeFromInputEventPick (SceneObject *pSceneObject)
 
void addInputListener (SimObject *pSimObject)
 
void removeInputListener (SimObject *pSimObject)
 
void windowToScenePoint (const Vector2 &srcPoint, Vector2 &dstPoint) const
 Coordinate Conversion.
 
void sceneToWindowPoint (const Vector2 &srcPoint, Vector2 &dstPoint) const
 
void mount (SceneObject *pSceneObject, const Vector2 &mountOffset, const F32 mountForce, const bool sendToMount, const bool mountAngle)
 Mounting.
 
void dismount (void)
 
void dismountMe (SceneObject *pSceneObject)
 
void calculateCameraMount (const F32 elapsedTime)
 
void interpolateCameraMount (const F32 timeDelta)
 
void setViewLimitOn (const Vector2 &limitMin, const Vector2 &limitMax)
 View Limit.
 
void setViewLimitOff (void)
 
bool isViewLimitOn (void) const
 
Vector2 getViewLimitMin (void) const
 
Vector2 getViewLimitMax (void) const
 
void clampCameraViewLimit (void)
 
void setShowScrollBar (bool setting)
 
bool getShowScrollBar ()
 
void updateScrollBar ()
 
void setMouseWheelScrolls (bool setting)
 
bool getMouseWheelScrolls ()
 
void zeroCameraTime (void)
 Tick Processing.
 
void resetTickCameraTime (void)
 
void updateTickCameraTime (void)
 
void resetTickCameraPosition (void)
 
virtual void interpolateTick (F32 delta)
 
virtual void processTick ()
 
virtual void advanceTime (F32 timeDelta)
 
virtual void setCameraPosition (const Vector2 &position)
 Camera,.
 
Vector2 getCameraPosition (void) const
 
void setCameraSize (const Vector2 &size)
 
Vector2 getCameraSize (void) const
 
virtual void setCameraArea (const RectF &cameraWindow)
 
RectF getCameraArea (void) const
 
void setCameraZoom (const F32 zoomFactor)
 
F32 getCameraZoom (void) const
 
void setCameraAngle (const F32 cameraAngle)
 
F32 getCameraAngle (void) const
 
virtual void setTargetCameraPosition (const Vector2 &position)
 Target Camera.
 
Vector2 getTargetCameraPosition (void) const
 
void setTargetCameraSize (const Vector2 &size)
 
Vector2 getTargetCameraSize (void) const
 
virtual void setTargetCameraArea (const RectF &cameraWindow)
 
RectF getTargetCameraArea (void) const
 
void setTargetCameraZoom (const F32 zoomFactor)
 
F32 getTargetCameraZoom (void) const
 
void setTargetCameraAngle (const F32 cameraAngle)
 
F32 getTargetCameraAngle (void) const
 
void setCameraInterpolationTime (const F32 interpolationTime)
 Camera Interpolation Time/Mode.
 
void setCameraInterpolationMode (const CameraInterpolationMode interpolationMode)
 
void setProcessAudioListener (bool mval)
 Audio Listener.
 
void startCameraMove (const F32 interpolationTime)
 Camera Movement.
 
void stopCameraMove (void)
 
void completeCameraMove (void)
 
void undoCameraMove (const F32 interpolationTime)
 
F32 interpolate (F32 from, F32 to, F32 delta)
 
void updateCamera (void)
 
Vector2 getCameraRenderPosition (void)
 
RectF getCameraRenderArea (void)
 
const Vector2 getCameraWindowScale (void) const
 
F32 getCameraInterpolationTime (void)
 
const CameraViewgetCamera (void) const
 
const Vector2getCameraShake (void) const
 
bool isCameraMounted (void) const
 
bool isCameraMoving (void) const
 
bool isProcessAudioListener (void) const
 Audio Listener.
 
void startCameraShake (const F32 magnitude, const F32 time)
 Camera Shake.
 
void stopCameraShake (void)
 
virtual void resize (const Point2I &newPosition, const Point2I &newExtent)
 GuiControl.
 
virtual void onRender (Point2I offset, const RectI &updateRect)
 
virtual void onTouchEnter (const GuiEvent &event)
 
virtual void onTouchLeave (const GuiEvent &event)
 
virtual void onTouchDown (const GuiEvent &event)
 
virtual void onTouchUp (const GuiEvent &event)
 
virtual void onTouchMove (const GuiEvent &event)
 
virtual void onTouchDragged (const GuiEvent &event)
 
virtual void onMiddleMouseDown (const GuiEvent &event)
 
virtual void onMiddleMouseUp (const GuiEvent &event)
 
virtual void onMiddleMouseDragged (const GuiEvent &event)
 
virtual void onRightMouseDown (const GuiEvent &event)
 
virtual void onRightMouseUp (const GuiEvent &event)
 
virtual void onRightMouseDragged (const GuiEvent &event)
 
virtual void onMouseWheelDown (const GuiEvent &event)
 
virtual void onMouseWheelUp (const GuiEvent &event)
 
void setUseConstantThumbHeight (const bool setting)
 
void setScrollBarThickness (const S32 thickness)
 
void setShowArrowButtons (const bool setting)
 
void renderMetricsOverlay (Point2I offset, const RectI &updateRect)
 
 DECLARE_CONOBJECT (SceneWindow)
 Declare Console Object.
 
- Public Member Functions inherited from GuiControl
virtual bool isEditMode ()
 
virtual bool isEditSelected ()
 
virtual void getScrollLineSizes (U32 *rowHeight, U32 *columnWidth)
 
virtual void getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)
 
void awaken ()
 Called when this control and its children have been wired up.
 
void sleep ()
 Called when this control is no more.
 
void preRender ()
 Prerender this control and all its children.
 
bool sendScriptMouseEvent (const char *name, const GuiEvent &event)
 
bool sendScriptKeyEvent (const char *name, const InputEvent &event)
 
virtual bool onInputEvent (const InputEvent &event)
 General input handler.
 
virtual void onFocus (bool foundFirstResponder)
 
virtual bool ControlIsChild (GuiControl *child)
 
virtual void setControlProfile (GuiControlProfile *prof)
 
virtual void onAction ()
 Occurs when this control performs its "action".
 
void renderText (const Point2I &offset, const Point2I &extent, const char *text, GuiControlProfile *profile, TextRotationOptions rot=tRotateNone)
 
virtual void renderLineList (const Point2I &offset, const Point2I &extent, const S32 startOffsetY, const vector< string > lineList, GuiControlProfile *profile, const TextRotationOptions rot=tRotateNone)
 
virtual vector< string > getLineList (const char *text, GuiControlProfile *profile, S32 totalWidth)
 
virtual void renderTextLine (const Point2I &startPoint, const string line, GuiControlProfile *profile, F32 rotationInDegrees, U32 ibeamPosAtLineStart, U32 lineNumber)
 
RectI applyMargins (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 Returns a new rect based on the margins.
 
RectI applyBorders (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 Returns the bounds of the rect after considering the borders.
 
RectI applyPadding (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 Returns the bounds of the rect this time with padding.
 
RectI getInnerRect (GuiControlState currentState=GuiControlState::NormalState)
 Returns the bounds of the rect with margin, borders, and padding applied.
 
RectI getInnerRect (Point2I &offset, GuiControlState currentState=GuiControlState::NormalState)
 
virtual RectI getInnerRect (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
 
Point2I getOuterExtent (Point2I &innerExtent, GuiControlState currentState, GuiControlProfile *profile)
 Returns the extent of the outer rect given the extent of the inner rect.
 
S32 getOuterWidth (S32 innerExtent, GuiControlState currentState, GuiControlProfile *profile)
 
S32 getOuterHeight (S32 innerExtent, GuiControlState currentState, GuiControlProfile *profile)
 
virtual void inspectPostApply ()
 
virtual void inspectPreApply ()
 
Point2I extentBattery (Point2I &newExtent)
 
void resetStoredExtent ()
 
Point2F relPosBatteryH (S32 pos, S32 ext, S32 parentExt)
 
Point2F relPosBatteryV (S32 pos, S32 ext, S32 parentExt)
 
void relPosBattery (Point2F &battery, S32 pos, S32 ext, S32 parentExt)
 
void resetStoredRelPos ()
 
virtual void setDataField (StringTableEntry slotName, const char *array, const char *value)
 
void setSizing (S32 horz, S32 vert)
 
void write (Stream &stream, U32 tabStop, U32 flags)
 Overrides Parent Serialization to allow specific controls to not be saved (Dynamic Controls, etc)
 
bool getCanSave ()
 Returns boolean specifying if a control can be serialized.
 
void setCanSave (bool bCanSave)
 Set serialization flag.
 
bool getCanSaveParent ()
 Returns boolean as to whether any parent of this control has the 'no serialization' flag set.
 
virtual void setVisible (bool value)
 
bool isVisible ()
 Returns true if the object is visible.
 
virtual void setActive (bool value)
 
bool isActive ()
 Returns true if this control is active.
 
bool isAwake ()
 Returns true if this control is awake.
 
virtual void addObject (SimObject *obj)
 
void removeObject (SimObject *obj)
 
GuiControlgetParent ()
 Returns the control which owns this one.
 
GuiCanvasgetRoot ()
 Returns the root canvas of this control.
 
virtual Point2I localToGlobalCoord (const Point2I &src)
 
virtual Point2I globalToLocalCoord (const Point2I &src)
 
virtual void setPosition (const Point2I &newPosition)
 
virtual void setExtent (const Point2I &newExtent)
 
virtual void setBounds (const RectI &newBounds)
 
virtual void setLeft (S32 newLeft)
 
virtual void setTop (S32 newTop)
 
virtual void setWidth (S32 newWidth)
 
virtual void setHeight (S32 newHeight)
 
virtual void childResized (GuiControl *child)
 
virtual void childMoved (GuiControl *child)
 
virtual void childrenReordered ()
 Called when the children of this control may have been reordered.
 
virtual void parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)
 
void preventResizeModeFill ()
 Removes the resize mode of fill and changes it to right or bottom.
 
void preventResizeModeCenter ()
 Removes the resize mode of center and changes it to right or bottom.
 
virtual bool renderTooltip (Point2I &cursorPos, const char *tipText=NULL)
 
virtual void renderChildControls (const Point2I &offset, const RectI &content, const RectI &updateRect)
 
virtual void renderChild (GuiControl *ctrl, const Point2I &offset, const RectI &content, const RectI &clipRect)
 Renders a single child control.
 
void setUpdateRegion (Point2I pos, Point2I ext)
 
virtual void setUpdate ()
 Sets the update area of the control to encompass the whole control.
 
virtual void onPreRender ()
 Do special pre-render proecessing.
 
virtual void onGroupRemove ()
 Called when this object is removed using delete or parent.remove().
 
virtual void onChildAdded (GuiControl *child)
 Called when this object has a new child. Congratulations!
 
virtual void onChildRemoved (GuiControl *child)
 Called when a child is removed.
 
virtual bool pointInControl (const Point2I &parentCoordPoint)
 
bool cursorInControl ()
 Returns true if the global cursor is inside this control.
 
virtual GuiControlfindHitControl (const Point2I &pt, S32 initialLayer=-1)
 
virtual void mouseLock (GuiControl *lockingControl)
 
virtual void mouseLock ()
 Turn on mouse locking with last used lock control.
 
virtual void mouseUnlock ()
 Unlock the mouse.
 
virtual bool isMouseLocked ()
 Returns true if the mouse is locked.
 
virtual bool onMouseDownEditor (const GuiEvent &event, const Point2I &offset)
 
virtual bool onMouseUpEditor (const GuiEvent &event, const Point2I &offset)
 
virtual bool onRightMouseDownEditor (const GuiEvent &event, const Point2I &offset)
 
virtual bool onMouseDraggedEditor (const GuiEvent &event, const Point2I &offset)
 
virtual GuiControlfindFirstTabable ()
 Find the first tab-accessable child of this control.
 
virtual GuiControlfindLastTabable (bool firstCall=true)
 
virtual GuiControlfindPrevTabable (GuiControl *curResponder, bool firstCall=true)
 
virtual GuiControlfindNextTabable (GuiControl *curResponder, bool firstCall=true)
 
virtual void setFirstResponder (GuiControl *firstResponder)
 
virtual void makeFirstResponder (bool value)
 
bool isFirstResponder ()
 Returns true if this control is a first responder.
 
virtual void setFirstResponder ()
 Sets this object to be a first responder.
 
void clearFirstResponder ()
 Clears the first responder for this chain.
 
void clearFirstResponder (GuiControl *target)
 
GuiControlgetFirstResponder ()
 Returns the first responder for this chain.
 
virtual void onLoseFirstResponder ()
 Occurs when the first responder for this chain is lost.
 
void addAcceleratorKey ()
 Adds the accelerator key for this object to the canvas.
 
virtual void buildAcceleratorMap ()
 
virtual void acceleratorKeyPress (U32 index)
 
virtual void acceleratorKeyRelease (U32 index)
 
virtual bool onKeyDown (const GuiEvent &event)
 
virtual bool onKeyUp (const GuiEvent &event)
 
virtual bool onKeyRepeat (const GuiEvent &event)
 
void messageSiblings (S32 message)
 Send a message to all siblings.
 
virtual void onMessage (GuiControl *sender, S32 msg)
 Receive a message from another control.
 
virtual void onDialogPush ()
 Called if this object is a dialog, when it is added to the visible layers.
 
virtual void onDialogPop ()
 Called if this object is a dialog, when it is removed from the visible layers.
 
void setConsoleVariable (const char *variable)
 
void setConsoleCommand (const char *newCmd)
 
const char * getConsoleCommand ()
 Returns the name of the function bound to this GuiControl.
 
LangTablegetGUILangTable (void)
 
const UTF8 * getGUIString (S32 id)
 
virtual const char * getScriptValue ()
 Returns the value of the variable bound to this object.
 
virtual void setScriptValue (const char *value)
 Sets the value of the variable bound to this object.
 
 DECLARE_CONOBJECT (GuiControl)
 
 GuiControl ()
 
virtual ~GuiControl ()
 
const Point2IgetPosition ()
 Returns position of the control.
 
const Point2IgetExtent ()
 Returns extents of the control.
 
const RectIgetBounds ()
 Returns the bounds of the control.
 
const Point2IgetMinExtent ()
 Returns minimum size the control can be.
 
const S32 getLeft ()
 Returns the X position of the control.
 
const S32 getTop ()
 Returns the Y position of the control.
 
const S32 getWidth ()
 Returns the width of the control.
 
const S32 getHeight ()
 Returns the height of the control.
 
virtual void setText (const char *text)
 
virtual void setTextID (S32 id)
 
virtual void setTextID (const char *id)
 
virtual const char * getText ()
 
void setTextWrap (const bool wrap)
 
bool getTextWrap ()
 
void setTextExtend (const bool extend)
 
bool getTextExtend ()
 
const horizSizingOptions getHorizSizing ()
 
const vertSizingOptions getVertSizing ()
 
void setHorizSizing (const horizSizingOptions sizing)
 
void setVertSizing (const vertSizingOptions sizing)
 
- Public Member Functions inherited from SimGroup
 ~SimGroup ()
 
void addObject (SimObject *, SimObjectId)
 
void addObject (SimObject *, const char *name)
 
virtual void onChildRemoved (SimObject *)
 
virtual SimObjectfindObject (const char *name)
 Find an object in the group.
 
bool processArguments (S32 argc, const char **argv)
 Process constructor options. (ie, new SimObject(1,2,3))
 
 DECLARE_CONOBJECT (SimGroup)
 
- Public Member Functions inherited from SimSet
 SimSet ()
 
 ~SimSet ()
 
virtual void onDeleteNotify (SimObject *object)
 
virtual U32 getTamlChildCount (void) const
 Called when Taml attempts to compile a list of children.
 
virtual SimObjectgetTamlChild (const U32 childIndex) const
 Called when Taml attempts to compile a list of children.
 
virtual void addTamlChild (SimObject *pSimObject)
 Called when Taml attempts to populate an objects children during a read.
 
void callOnChildren (const char *method, S32 argc, const char *argv[], bool executeOnChildGroups=true)
 
SimObjectfindObjectByInternalName (const char *internalName, bool searchChildren=false)
 
virtual bool writeObject (Stream *stream)
 
virtual bool readObject (Stream *stream)
 
void lock ()
 
void unlock ()
 
 DECLARE_CONOBJECT (SimSet)
 
void _setVectorAssoc (const char *file, const U32 line)
 
virtual void pushObject (SimObject *)
 
virtual void popObject ()
 Remove an object from the end of the list.
 
void bringObjectToFront (SimObject *obj)
 
void pushObjectToBack (SimObject *obj)
 
SimObjectfront ()
 
SimObjectfirst ()
 
SimObjectlast ()
 
bool empty ()
 
S32 size () const
 
iterator begin ()
 
iterator end ()
 
value operator[] (S32 index)
 
iterator find (iterator first, iterator last, SimObject *obj)
 
iterator find (SimObject *obj)
 
template<typename T >
bool containsType (void)
 
bool isMember (SimObject *obj)
 
virtual bool reOrder (SimObject *obj, SimObject *target=0)
 
SimObjectat (S32 index) const
 
void deleteObjects (void)
 
void clear ()
 
- Public Member Functions inherited from SimObject
StringTableEntry getClassNamespace () const
 
StringTableEntry getSuperClassNamespace () const
 
void setClassNamespace (const char *classNamespace)
 
void setSuperClassNamespace (const char *superClassNamespace)
 
void pushScriptCallbackGuard (void)
 
void popScriptCallbackGuard (void)
 
S32 getScriptCallbackGuard (void)
 
NamespacegetNamespace ()
 Return the object's namespace.
 
const char * tabComplete (const char *prevText, S32 baseLen, bool)
 
virtual void dump ()
 
virtual void dumpClassHierarchy ()
 
SimObjectclone (const bool copyDynamicFields)
 
virtual void copyTo (SimObject *object)
 
template<typename T >
bool isType (void)
 
virtual bool handlesConsoleMethod (const char *fname, S32 *routingId)
 
 DECLARE_CONOBJECT (SimObject)
 
NotifyremoveNotify (void *ptr, Notify::Type)
 Remove a notification from the list.
 
void deleteNotify (SimObject *obj)
 Notify an object when we are deleted.
 
void clearNotify (SimObject *obj)
 Notify an object when we are cleared.
 
void clearAllNotifications ()
 Remove all notifications for this object.
 
void processDeleteNotifies ()
 Send out deletion notifications.
 
void registerReference (SimObject **obj)
 
void unregisterReference (SimObject **obj)
 
void addListener (std::string objID)
 
void removeListener (std::string objID)
 
void removeAllListeners ()
 
void postEvent (std::string eventName, std::string data)
 
const char * getDataField (StringTableEntry slotName, const char *array)
 
const char * getPrefixedDataField (StringTableEntry fieldName, const char *array)
 
void setPrefixedDataField (StringTableEntry fieldName, const char *array, const char *value)
 
const char * getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)
 
void setPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1)
 
StringTableEntry getDataFieldPrefix (StringTableEntry fieldName)
 
U32 getDataFieldType (StringTableEntry slotName, const char *array)
 
SimFieldDictionarygetFieldDictionary ()
 
void clearDynamicFields (void)
 Clear all dynamic fields.
 
void setCanSaveDynamicFields (bool bCanSave)
 Set whether fields created at runtime should be saved. Default is true.
 
bool getCanSaveDynamicFields (void) const
 Get whether fields created at runtime should be saved. Default is true.
 
void setInternalName (const char *newname)
 
StringTableEntry getInternalName ()
 Get the internal of of this control.
 
virtual bool save (const char *pcFilePath, bool bOnlySelected=false)
 Save object as a TorqueScript File.
 
virtual bool isMethod (const char *methodName)
 Check if a method exists in the objects current namespace.
 
SimObjectId getId (void) const
 
StringTableEntry getIdString (void) const
 
U32 getType () const
 
const StringTableEntry getName (void) const
 
void setId (SimObjectId id)
 
void assignName (const char *name)
 
SimGroupgetGroup () const
 
bool isChildOfGroup (SimGroup *pGroup)
 
bool isProperlyAdded () const
 
bool isDeleted () const
 
bool isRemoved () const
 
bool isLocked () const
 
void setLocked (bool b)
 
bool isHidden () const
 
void setHidden (bool b)
 
void setProgenitorFile (const char *pFile)
 
StringTableEntry getProgenitorFile (void) const
 
void setPeriodicTimerID (const S32 timerID)
 
S32 getPeriodicTimerID (void) const
 
bool isPeriodicTimerActive (void) const
 
bool isSelected () const
 
bool isExpanded () const
 
void setSelected (bool sel)
 
void setExpanded (bool exp)
 
void setModDynamicFields (bool dyn)
 
void setModStaticFields (bool sta)
 
 SimObject ()
 
virtual ~SimObject ()
 
virtual void onGroupAdd ()
 Called when the object is added to a SimGroup.
 
virtual void onNameChange (const char *name)
 Called when the object's name is changed.
 
virtual void onStaticModified (const char *slotName, const char *newValue=NULL)
 
virtual void onEditorEnable ()
 Called when the editor is activated.
 
virtual void onEditorDisable ()
 Called when the editor is deactivated.
 
bool registerObject ()
 
bool registerObject (U32 id)
 
bool registerObject (const char *name)
 
bool registerObject (const char *name, U32 id)
 
void unregisterObject ()
 
void deleteObject ()
 
bool addToSet (SimObjectId)
 
bool addToSet (const char *)
 
bool removeFromSet (SimObjectId)
 
bool removeFromSet (const char *)
 
virtual bool writeField (StringTableEntry fieldname, const char *value)
 
virtual void writeFields (Stream &stream, U32 tabStop)
 
virtual void buildFilterList ()
 
void addFieldFilter (const char *fieldName)
 
void removeFieldFilter (const char *fieldName)
 
void clearFieldFilters ()
 
bool isFiltered (const char *fieldName)
 
void assignFieldsFrom (SimObject *obj)
 
void assignDynamicFieldsFrom (SimObject *obj)
 
- Public Member Functions inherited from ConsoleObject
const AbstractClassRep::FieldfindField (StringTableEntry fieldName) const
 Get a reference to a field by name.
 
virtual AbstractClassRepgetClassRep () const
 Gets the ClassRep.
 
bool setField (const char *fieldName, const char *value)
 Set the value of a field.
 
virtual ~ConsoleObject ()
 
const AbstractClassRep::FieldListgetFieldList () const
 Get a list of all the fields. This information cannot be modified.
 
AbstractClassRep::FieldListgetModifiableFieldList ()
 
bool & getDynamicGroupExpand ()
 
S32 getClassId (U32 netClassGroup) const
 
const char * getClassName () const
 
- Public Member Functions inherited from Tickable
 Tickable ()
 
virtual ~Tickable ()
 
virtual bool isProcessingTicks () const
 
virtual void setProcessTicks (bool tick=true)
 

Static Public Member Functions

static void initPersistFields ()
 
static CameraInterpolationMode getInterpolationModeEnum (const char *label)
 
- Static Public Member Functions inherited from GuiControl
static void initPersistFields ()
 
static bool setTextProperty (void *obj, const char *data)
 
static const char * getTextProperty (void *obj, const char *data)
 
static bool writeTextWrapFn (void *obj, const char *data)
 
static bool writeTextExtendFn (void *obj, const char *data)
 
static bool setExtentFn (void *obj, const char *data)
 
static bool setMinExtentFn (void *obj, const char *data)
 
static bool writeMinExtentFn (void *obj, const char *data)
 
static bool setPositionFn (void *obj, const char *data)
 
- Static Public Member Functions inherited from SimObject
static void initPersistFields ()
 
- Static Public Member Functions inherited from ConsoleObject
static const char * lookupClassName (const U32 in_classTag)
 Get the classname from a class tag.
 
static void initPersistFields ()
 
static void consoleInit ()
 
static AbstractClassRepgetStaticClassRep ()
 Get the abstract class information for this class.
 
static AbstractClassRepgetParentStaticClassRep ()
 Get the abstract class information for this class's superclass.
 
static ConsoleObjectcreate (const char *in_pClassName)
 
static ConsoleObjectcreate (const U32 groupId, const U32 typeId, const U32 in_classId)
 
- Static Public Member Functions inherited from Tickable
static bool advanceTime (U32 timeDelta)
 

Public Attributes

enum SceneWindow::CameraInterpolationMode mCameraInterpolationMode
 
- Public Attributes inherited from GuiControl
GuiControlProfilemProfile
 
GuiControlProfilemTooltipProfile
 
S32 mTipHoverTime
 
S32 mTooltipWidth
 
bool mVisible
 
bool mActive
 
bool mAwake
 
bool mSetFirstResponder
 
bool mCanSave
 
bool mIsContainer
 if true, then the GuiEditor can drag other controls into this one.
 
bool mUseInput
 True if input events like a click can be passed to this gui. False will pass events to the parent and this object and its children will not process input (touch and keyboard).
 
S32 mLayer
 
RectI mBounds
 
Point2I mMinExtent
 
Point2I mRenderInsetLT
 
Point2I mRenderInsetRB
 Add this to the mBounds and parent offset to get the true render location of the control.
 
StringTableEntry mLangTableName
 The actual rendered inset for the right and bottom sides.
 
LangTablemLangTable
 
GuiControlmFirstResponder
 

Static Protected Member Functions

static bool writeLockMouse (void *obj, StringTableEntry pFieldName)
 
static bool writeUseWindowInputEvents (void *obj, StringTableEntry pFieldName)
 
static bool writeUseObjectInputEvents (void *obj, StringTableEntry pFieldName)
 
static bool writeBackgroundColor (void *obj, StringTableEntry pFieldName)
 
static bool writeUseBackgroundColor (void *obj, StringTableEntry pFieldName)
 
static bool writeScrollSettingFn (void *obj, StringTableEntry pFieldName)
 
static bool setConstantThumbFn (void *obj, const char *data)
 
static bool setScrollBarThicknessFn (void *obj, const char *data)
 
static bool setShowArrowButtonsFn (void *obj, const char *data)
 
static bool setThumbProfileFn (void *obj, const char *data)
 
static bool setTrackProfileFn (void *obj, const char *data)
 
static bool setArrowProfileFn (void *obj, const char *data)
 
- Static Protected Member Functions inherited from SimObject
static bool setClass (void *obj, const char *data)
 
static bool setSuperClass (void *obj, const char *data)
 
static bool writeObjectName (void *obj, StringTableEntry pFieldName)
 
static bool writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)
 
static bool writeInternalName (void *obj, StringTableEntry pFieldName)
 
static bool setParentGroup (void *obj, const char *data)
 
static bool writeParentGroup (void *obj, StringTableEntry pFieldName)
 
static bool writeSuperclass (void *obj, StringTableEntry pFieldName)
 
static bool writeClass (void *obj, StringTableEntry pFieldName)
 
static bool setProtectedName (void *obj, const char *data)
 
static SimObject::NotifyallocNotify ()
 Get a free Notify structure.
 
static void freeNotify (SimObject::Notify *)
 Mark a Notify structure as free.
 
- Static Protected Member Functions inherited from ConsoleObject
static void addGroup (const char *in_pGroupname, const char *in_pGroupDocs=NULL)
 
static void endGroup (const char *in_pGroupname)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char *in_pFieldDocs)
 
static void addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char *in_pFieldDocs)
 
static void addFieldV (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator *v, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char *in_pFieldDocs=NULL)
 
static void addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char *in_pFieldDocs=NULL)
 
static void addDepricatedField (const char *fieldName)
 
static bool removeField (const char *in_pFieldname)
 

Additional Inherited Members

- Static Public Attributes inherited from GuiControl
static GuiEditCtrlsmEditorHandle = NULL
 static GuiEditCtrl pointer that gives controls access to editor-NULL if editor is closed
 
static S32 smCursorChanged = -1
 Has this control modified the cursor? -1 or type.
 
static bool smDesignTime = false
 static GuiControl boolean that specifies if the GUI Editor is active
 
static GuiControlsmPrevResponder = NULL
 
static GuiControlsmCurResponder = NULL
 
- Static Public Attributes inherited from SimObject
static bool disableNameChanging = false
 
- Static Public Attributes inherited from Tickable
static const U32 smTickShift = 4
 Shift value to control how often Ticks occur.
 
static const U32 smTickMs = ( 1 << smTickShift )
 Number of milliseconds per tick, 32 in this case.
 
static const F32 smTickSec = ( F32( Tickable::smTickMs ) / 1000.f )
 Fraction of a second per tick.
 
static const U32 smTickMask = ( smTickMs - 1 )
 
- Protected Member Functions inherited from GuiControl
S32 getTextHorizontalOffset (S32 textWidth, S32 totalWidth, AlignmentType align)
 
S32 getTextVerticalOffset (S32 textHeight, S32 totalHeight, VertAlignmentType align)
 
AlignmentType getAlignmentType ()
 
VertAlignmentType getVertAlignmentType ()
 
AlignmentType getAlignmentType (GuiControlProfile *profile)
 
VertAlignmentType getVertAlignmentType (GuiControlProfile *profile)
 
const ColorIgetFontColor (GuiControlProfile *profile, const GuiControlState state=GuiControlState::NormalState)
 
const char * execConsoleCallback ()
 Executes mConsoleCommand, and returns the result.
 
const char * execAltConsoleCallback ()
 Executes mAltConsoleCommand, and returns the result.
 
void setVariable (const char *value)
 
void setIntVariable (S32 value)
 
void setFloatVariable (F32 value)
 
const char * getVariable ()
 Returns value of control's bound variable as a string.
 
S32 getIntVariable ()
 Returns value of control's bound variable as a integer.
 
F32 getFloatVariable ()
 Returns value of control's bound variable as a float.
 
- Protected Member Functions inherited from SimObject
virtual void onTamlPreWrite (void)
 Taml callbacks.
 
virtual void onTamlPostWrite (void)
 Called after Taml has finished writing the object.
 
virtual void onTamlPreRead (void)
 Called prior to Taml reading the object.
 
virtual void onTamlPostRead (const TamlCustomNodes &customNodes)
 
virtual void onTamlAddParent (SimObject *pParentObject)
 Called after Taml has finished reading the object and has added the object to any parent.
 
virtual void onTamlCustomWrite (TamlCustomNodes &customNodes)
 Called during the writing of the object to allow custom properties to be written.
 
virtual void onTamlCustomRead (const TamlCustomNodes &customNodes)
 Called during the reading of the object to allow custom properties to be read.
 
void linkNamespaces ()
 
void unlinkNamespaces ()
 
- Protected Member Functions inherited from ConsoleObject
 ConsoleObject ()
 
 ConsoleObject (const ConsoleObject &)
 
- Protected Attributes inherited from GuiControl
bool mPreviouslyAwake
 
S32 mHorizSizing
 Set from horizSizingOptions.
 
S32 mVertSizing
 Set from vertSizingOptions.
 
Point2I mStoredExtent
 
Point2F mStoredRelativePosH
 
Point2F mStoredRelativePosV
 
bool mUseRelPosH
 
bool mUseRelPosV
 
StringTableEntry mConsoleVariable
 
StringTableEntry mConsoleCommand
 
StringTableEntry mAltConsoleCommand
 
StringTableEntry mAcceleratorKey
 
StringTableEntry mTooltip
 
StringTableEntry mText
 
StringTableEntry mTextID
 
bool mTextWrap
 
bool mTextExtend
 
AlignmentType mAlignment
 
VertAlignmentType mVAlignment
 
F32 mFontSizeAdjust
 
ColorI mFontColor
 
bool mOverrideFontColor
 
- Protected Attributes inherited from SimSet
SimObjectList objectList
 
void * mMutex
 
- Protected Attributes inherited from SimObject
SimObjectId mId
 Id number for this object.
 
StringTableEntry mIdString
 
NamespacemNameSpace
 
U32 mTypeMask
 
S32 mScriptCallbackGuard
 Whether the object is executing a script callback.
 
bool mCanSaveFieldDictionary
 true if dynamic fields (added at runtime) should be saved, defaults to true
 
StringTableEntry mInternalName
 Stores object Internal Name.
 
StringTableEntry mClassName
 Stores the class name to link script class namespaces.
 
StringTableEntry mSuperClassName
 Stores super class name to link script class namespaces.
 
- Static Protected Attributes inherited from SimObject
static SimObject::NotifymNotifyFreeList = NULL
 

Member Enumeration Documentation

◆ CameraInterpolationMode

Camera Interpolation Mode.

Enumerator
INVALID_INTERPOLATION_MODE 
LINEAR 

Standard Linear.

SIGMOID 

Slow Start / Slow Stop.

Constructor & Destructor Documentation

◆ SceneWindow()

◆ ~SceneWindow()

~SceneWindow ( )
virtual

Member Function Documentation

◆ addInputListener()

void addInputListener ( SimObject pSimObject)

◆ advanceTime()

virtual void advanceTime ( F32  timeDelta)
inlinevirtual

This method is called once every frame regardless of the return value of isProcessingTicks and informs the object of the passage of time

Reimplemented from GuiControl.

◆ calculateCameraMount()

void calculateCameraMount ( const F32  elapsedTime)

◆ clampCameraViewLimit()

void clampCameraViewLimit ( void  )

◆ clearWatchedInputEvents()

void clearWatchedInputEvents ( void  )
inline

◆ completeCameraMove()

void completeCameraMove ( void  )

◆ DECLARE_CONOBJECT()

DECLARE_CONOBJECT ( SceneWindow  )

Declare Console Object.

◆ dismount()

void dismount ( void  )

◆ dismountMe()

void dismountMe ( SceneObject pSceneObject)

◆ getBackgroundColor()

const ColorF & getBackgroundColor ( void  ) const
inline

◆ getCamera()

const CameraView & getCamera ( void  ) const
inline

◆ getCameraAngle()

F32 getCameraAngle ( void  ) const
inline

◆ getCameraArea()

RectF getCameraArea ( void  ) const
inline

◆ getCameraInterpolationTime()

F32 getCameraInterpolationTime ( void  )
inline

◆ getCameraPosition()

Vector2 getCameraPosition ( void  ) const
inline

◆ getCameraRenderArea()

RectF getCameraRenderArea ( void  )
inline

◆ getCameraRenderPosition()

Vector2 getCameraRenderPosition ( void  )
inline

◆ getCameraShake()

const Vector2 & getCameraShake ( void  ) const
inline

◆ getCameraSize()

Vector2 getCameraSize ( void  ) const
inline

◆ getCameraWindowScale()

const Vector2 getCameraWindowScale ( void  ) const
inline

◆ getCameraZoom()

F32 getCameraZoom ( void  ) const
inline

◆ getInterpolationModeEnum()

SceneWindow::CameraInterpolationMode getInterpolationModeEnum ( const char *  label)
static

◆ getLockMouse()

bool getLockMouse ( void  )
inline

◆ getMousePosition()

Vector2 getMousePosition ( void  )

◆ getMouseWheelScrolls()

bool getMouseWheelScrolls ( )
inline

◆ getRenderGroupMask()

U32 getRenderGroupMask ( void  )
inline

◆ getRenderLayerMask()

U32 getRenderLayerMask ( void  )
inline

◆ getScene()

Scene * getScene ( void  ) const
inline

Get scene.

◆ getShowScrollBar()

bool getShowScrollBar ( )
inline

◆ getTargetCameraAngle()

F32 getTargetCameraAngle ( void  ) const
inline

◆ getTargetCameraArea()

RectF getTargetCameraArea ( void  ) const
inline

◆ getTargetCameraPosition()

Vector2 getTargetCameraPosition ( void  ) const
inline

◆ getTargetCameraSize()

Vector2 getTargetCameraSize ( void  ) const
inline

◆ getTargetCameraZoom()

F32 getTargetCameraZoom ( void  ) const
inline

◆ getUseBackgroundColor()

bool getUseBackgroundColor ( void  ) const
inline

◆ getUseObjectInputEvents()

bool getUseObjectInputEvents ( void  ) const
inline

◆ getUseWindowInputEvents()

bool getUseWindowInputEvents ( void  ) const
inline

◆ getViewLimitMax()

Vector2 getViewLimitMax ( void  ) const
inline

◆ getViewLimitMin()

Vector2 getViewLimitMin ( void  ) const
inline

◆ initPersistFields()

void initPersistFields ( )
static

◆ interpolate()

F32 interpolate ( F32  from,
F32  to,
F32  delta 
)

◆ interpolateCameraMount()

void interpolateCameraMount ( const F32  timeDelta)

◆ interpolateTick()

void interpolateTick ( F32  delta)
virtual

This method is called every frame and lets the control interpolate between ticks so you can smooth things as long as isProcessingTicks returns true when it is called on the object

Reimplemented from GuiControl.

◆ isCameraMounted()

bool isCameraMounted ( void  ) const
inline

◆ isCameraMoving()

bool isCameraMoving ( void  ) const
inline

◆ isProcessAudioListener()

bool isProcessAudioListener ( void  ) const
inline

Audio Listener.

◆ isViewLimitOn()

bool isViewLimitOn ( void  ) const
inline

◆ mount()

void mount ( SceneObject pSceneObject,
const Vector2 mountOffset,
const F32  mountForce,
const bool  sendToMount,
const bool  mountAngle 
)

Mounting.

◆ onAdd()

bool onAdd ( void  )
virtual

Called when this object is added to the scene.

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onMiddleMouseDown()

void onMiddleMouseDown ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

◆ onMiddleMouseDragged()

void onMiddleMouseDragged ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

◆ onMiddleMouseUp()

void onMiddleMouseUp ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

◆ onMouseWheelDown()

void onMouseWheelDown ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onMouseWheelUp()

void onMouseWheelUp ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onRemove()

void onRemove ( )
virtual

Called when this object is removed using delete.

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onRender()

void onRender ( Point2I  offset,
const RectI updateRect 
)
virtual

Called when this control is to render itself

Parameters
offsetThe location this control is to begin rendering
updateRectThe screen area this control has drawing access to

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onRightMouseDown()

void onRightMouseDown ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onRightMouseDragged()

void onRightMouseDragged ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onRightMouseUp()

void onRightMouseUp ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onSleep()

void onSleep ( )
virtual

Called when this object is asked to sleep.

Reimplemented from GuiControl.

◆ onTouchDown()

void onTouchDown ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onTouchDragged()

void onTouchDragged ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onTouchEnter()

void onTouchEnter ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

◆ onTouchLeave()

void onTouchLeave ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

◆ onTouchMove()

void onTouchMove ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onTouchUp()

void onTouchUp ( const GuiEvent event)
virtual

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ onWake()

bool onWake ( )
virtual

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

◆ processTick()

void processTick ( )
virtual

This method is called once every 32ms if isProcessingTicks returns true when called on the object

Reimplemented from GuiControl.

◆ removeFromInputEventPick()

void removeFromInputEventPick ( SceneObject pSceneObject)
inline

◆ removeInputListener()

void removeInputListener ( SimObject pSimObject)

◆ renderMetricsOverlay()

void renderMetricsOverlay ( Point2I  offset,
const RectI updateRect 
)

◆ resetScene()

void resetScene ( void  )
virtual

◆ resetTickCameraPosition()

void resetTickCameraPosition ( void  )

◆ resetTickCameraTime()

void resetTickCameraTime ( void  )

◆ resize()

void resize ( const Point2I newPosition,
const Point2I newExtent 
)
virtual

GuiControl.

Reimplemented from GuiControl.

Reimplemented in EditorToySceneWindow.

◆ sceneToWindowPoint()

void sceneToWindowPoint ( const Vector2 srcPoint,
Vector2 dstPoint 
) const

◆ setArrowProfileFn()

static bool setArrowProfileFn ( void *  obj,
const char *  data 
)
inlinestaticprotected

◆ setBackgroundColor()

void setBackgroundColor ( const ColorF backgroundColor)
inline

Background color.

◆ setCameraAngle()

void setCameraAngle ( const F32  cameraAngle)

◆ setCameraArea()

void setCameraArea ( const RectF cameraWindow)
virtual

◆ setCameraInterpolationMode()

void setCameraInterpolationMode ( const CameraInterpolationMode  interpolationMode)

◆ setCameraInterpolationTime()

void setCameraInterpolationTime ( const F32  interpolationTime)

Camera Interpolation Time/Mode.

◆ setCameraPosition()

void setCameraPosition ( const Vector2 position)
virtual

Camera,.

◆ setCameraSize()

void setCameraSize ( const Vector2 size)

◆ setCameraZoom()

void setCameraZoom ( const F32  zoomFactor)

◆ setConstantThumbFn()

static bool setConstantThumbFn ( void *  obj,
const char *  data 
)
inlinestaticprotected

◆ setControlArrowProfile()

void setControlArrowProfile ( GuiControlProfile prof)
virtual

◆ setControlThumbProfile()

void setControlThumbProfile ( GuiControlProfile prof)
virtual

◆ setControlTrackProfile()

void setControlTrackProfile ( GuiControlProfile prof)
virtual

◆ setLockMouse()

void setLockMouse ( bool  lockStatus)
inline

Mouse.

◆ setMousePosition()

void setMousePosition ( const Vector2 mousePosition)

◆ setMouseWheelScrolls()

void setMouseWheelScrolls ( bool  setting)
inline

◆ setObjectInputEventFilter()

void setObjectInputEventFilter ( const U32  groupMask,
const U32  layerMask,
const bool  useInvisible = false 
)

◆ setObjectInputEventGroupFilter()

void setObjectInputEventGroupFilter ( const U32  groupMask)

◆ setObjectInputEventInvisibleFilter()

void setObjectInputEventInvisibleFilter ( const bool  useInvisible)

◆ setObjectInputEventLayerFilter()

void setObjectInputEventLayerFilter ( const U32  layerMask)

◆ setProcessAudioListener()

void setProcessAudioListener ( bool  mval)

Audio Listener.

◆ setRenderGroups()

void setRenderGroups ( const U32  groupMask)
inline

◆ setRenderLayers()

void setRenderLayers ( const U32  layerMask)
inline

◆ setRenderMasks()

void setRenderMasks ( const U32  layerMask,
const U32  groupMask 
)
inline

◆ setScene()

void setScene ( Scene pScene)
virtual

Initialization.

◆ setScrollBarThickness()

void setScrollBarThickness ( const S32  thickness)

◆ setScrollBarThicknessFn()

static bool setScrollBarThicknessFn ( void *  obj,
const char *  data 
)
inlinestaticprotected

◆ setShowArrowButtons()

void setShowArrowButtons ( const bool  setting)

◆ setShowArrowButtonsFn()

static bool setShowArrowButtonsFn ( void *  obj,
const char *  data 
)
inlinestaticprotected

◆ setShowScrollBar()

void setShowScrollBar ( bool  setting)

◆ setTargetCameraAngle()

void setTargetCameraAngle ( const F32  cameraAngle)

◆ setTargetCameraArea()

void setTargetCameraArea ( const RectF cameraWindow)
virtual

◆ setTargetCameraPosition()

void setTargetCameraPosition ( const Vector2 position)
virtual

Target Camera.

◆ setTargetCameraSize()

void setTargetCameraSize ( const Vector2 size)

◆ setTargetCameraZoom()

void setTargetCameraZoom ( const F32  zoomFactor)

◆ setThumbProfileFn()

static bool setThumbProfileFn ( void *  obj,
const char *  data 
)
inlinestaticprotected

◆ setTrackProfileFn()

static bool setTrackProfileFn ( void *  obj,
const char *  data 
)
inlinestaticprotected

◆ setUseBackgroundColor()

void setUseBackgroundColor ( const bool  useBackgroundColor)
inline

◆ setUseConstantThumbHeight()

void setUseConstantThumbHeight ( const bool  setting)

◆ setUseObjectInputEvents()

void setUseObjectInputEvents ( const bool  inputStatus)
inline

◆ setUseWindowInputEvents()

void setUseWindowInputEvents ( const bool  inputStatus)
inline

◆ setViewLimitOff()

void setViewLimitOff ( void  )
inline

◆ setViewLimitOn()

void setViewLimitOn ( const Vector2 limitMin,
const Vector2 limitMax 
)

View Limit.

◆ startCameraMove()

void startCameraMove ( const F32  interpolationTime)

Camera Movement.

◆ startCameraShake()

void startCameraShake ( const F32  magnitude,
const F32  time 
)

Camera Shake.

◆ stopCameraMove()

void stopCameraMove ( void  )

◆ stopCameraShake()

void stopCameraShake ( void  )

◆ undoCameraMove()

void undoCameraMove ( const F32  interpolationTime)

◆ updateCamera()

void updateCamera ( void  )

◆ updateScrollBar()

void updateScrollBar ( )

◆ updateTickCameraTime()

void updateTickCameraTime ( void  )

◆ windowToScenePoint()

void windowToScenePoint ( const Vector2 srcPoint,
Vector2 dstPoint 
) const

Coordinate Conversion.

◆ writeBackgroundColor()

static bool writeBackgroundColor ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected

◆ writeLockMouse()

static bool writeLockMouse ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected

◆ writeScrollSettingFn()

static bool writeScrollSettingFn ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected

◆ writeUseBackgroundColor()

static bool writeUseBackgroundColor ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected

◆ writeUseObjectInputEvents()

static bool writeUseObjectInputEvents ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected

◆ writeUseWindowInputEvents()

static bool writeUseWindowInputEvents ( void *  obj,
StringTableEntry  pFieldName 
)
inlinestaticprotected

◆ zeroCameraTime()

void zeroCameraTime ( void  )

Tick Processing.

Member Data Documentation

◆ mCameraInterpolationMode

enum SceneWindow::CameraInterpolationMode mCameraInterpolationMode

The documentation for this class was generated from the following files: