Click or drag to resize

GComponent Class

Component
Inheritance Hierarchy
SystemObject
  FairyGUIEventDispatcher
    FairyGUIGObject
      FairyGUIGComponent
        More...

Namespace:  FairyGUI
Assembly:  FairyGUI (in FairyGUI.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
public class GComponent : GObject

The GComponent type exposes the following members.

Constructors
  NameDescription
Public methodGComponent
Initializes a new instance of the GComponent class
Top
Properties
  NameDescription
Public propertyactualHeight
actualHeight = height * scaleY
(Inherited from GObject.)
Public propertyactualWidth
actualWidth = width * scalex
(Inherited from GObject.)
Public propertyalpha
The opacity of the object. 0 = transparent, 1 = opaque.
(Inherited from GObject.)
Public propertyapexIndex
Public propertyasButton (Inherited from GObject.)
Public propertyasCom (Inherited from GObject.)
Public propertyasComboBox (Inherited from GObject.)
Public propertyasGraph (Inherited from GObject.)
Public propertyasGroup (Inherited from GObject.)
Public propertyasImage (Inherited from GObject.)
Public propertyasLabel (Inherited from GObject.)
Public propertyasList (Inherited from GObject.)
Public propertyasLoader (Inherited from GObject.)
Public propertyasMovieClip (Inherited from GObject.)
Public propertyasProgress (Inherited from GObject.)
Public propertyasRichTextField (Inherited from GObject.)
Public propertyasSlider (Inherited from GObject.)
Public propertyasTextField (Inherited from GObject.)
Public propertyasTextInput (Inherited from GObject.)
Public propertybaseUserData
Public propertyblendMode
(Inherited from GObject.)
Public propertychildrenRenderOrder
Public propertyclipSoftness
If clipping softness is set, clipped containers will have soft border effect.
Public propertycontainer
Content container. If the component is not clipped, then container==rootContainer.
Public propertyControllers
Returns controller list.
Public propertydisplayObject
Lowlevel display object.
(Inherited from GObject.)
Public propertydraggable
(Inherited from GObject.)
Public propertydragging
(Inherited from GObject.)
Public propertyenabled
Enabled is shortcut for grayed and !touchable combination.
(Inherited from GObject.)
Public propertyfairyBatching
Draw call optimization switch.
Public propertyfilter
(Inherited from GObject.)
Public propertyfocusable
If the object can be focused?
(Inherited from GObject.)
Public propertyfocused
If the object is focused. Focused object can receive key events.
(Inherited from GObject.)
Public propertygameObjectName
设定GameObject的名称
(Inherited from GObject.)
Public propertygearLook
Gear to look controller.
(Inherited from GObject.)
Public propertygearSize
Gear to size controller.
(Inherited from GObject.)
Public propertygearXY
Gear to xy controller.
(Inherited from GObject.)
Public propertygrayed
If true, apply a grayed effect on this object.
(Inherited from GObject.)
Public propertygroup
Group belonging to.
(Inherited from GObject.)
Public propertyheight
The height of the object in pixels.
(Inherited from GObject.)
Public propertyicon
(Inherited from GObject.)
Public propertyid
GObject的id,仅作为内部使用。与name不同,id值是不会相同的。 id is for internal use only.
(Inherited from GObject.)
Public propertyinContainer
If the object has lowlevel displayobject and the displayobject has a container parent?
(Inherited from GObject.)
Public propertymargin
Public propertymask
The mask of the component.
Public propertynumChildren
The number of children of this component.
Public propertyonAddedToStage
Dispatched when the object was added to the stage.
(Inherited from GObject.)
Public propertyonClick
Dispatched when the object or its child was clicked.
(Inherited from GObject.)
Public propertyonClickLink
Dispatched when links in the object or its child was clicked.
(Inherited from GObject.)
Public propertyonDragEnd
Dispatched when drag end.
(Inherited from GObject.)
Public propertyonDragMove
Dispatched when dragging.
(Inherited from GObject.)
Public propertyonDragStart
Dispatched when drag start.
(Inherited from GObject.)
Public propertyonDrop
Dispatched when an object was dragged and dropped to this component.
Public propertyOnGearStop
(Inherited from GObject.)
Public propertyonKeyDown
Dispatched on key pressed when the object is in focus.
(Inherited from GObject.)
Public propertyonPositionChanged
Dispatched when the object was moved.
(Inherited from GObject.)
Public propertyonRemovedFromStage
Dispatched when the object was removed from the stage.
(Inherited from GObject.)
Public propertyonRightClick
Dispatched when the object or its child was clicked by right mouse button. Web only.
(Inherited from GObject.)
Public propertyonRollOut
The cursor or finger leave an object.
(Inherited from GObject.)
Public propertyonRollOver
The cursor or finger hovers over an object.
(Inherited from GObject.)
Public propertyonSizeChanged
Dispatched when the object was resized.
(Inherited from GObject.)
Public propertyonStage
If the object is on stage.
(Inherited from GObject.)
Public propertyonTouchBegin
Dispatched when the finger touched the object or its child just now.
(Inherited from GObject.)
Public propertyonTouchEnd
Dispatched when the finger was lifted from the screen or from the mouse button.
(Inherited from GObject.)
Public propertyonTouchMove
(Inherited from GObject.)
Public propertyopaque
If true, mouse/touch events cannot pass through the empty area of the component. Default is true.
Public propertyparent
Parent object.
(Inherited from GObject.)
Public propertypivot
The x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public propertypivotAsAnchor (Inherited from GObject.)
Public propertypivotX
The x coordinate of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public propertypivotY
The y coordinate of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public propertypixelSnapping (Inherited from GObject.)
Public propertyposition
The x,y,z coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyrelations
Relations Object.
(Inherited from GObject.)
Public propertyresourceURL
Resource url of this object.
(Inherited from GObject.)
Public propertyreversedMask
Public propertyroot
(Inherited from GObject.)
Public propertyrootContainer
Root container.
Public propertyrotation
The rotation around the z axis of the object in degrees.
(Inherited from GObject.)
Public propertyrotationX
The rotation around the x axis of the object in degrees.
(Inherited from GObject.)
Public propertyrotationY
The rotation around the y axis of the object in degrees.
(Inherited from GObject.)
Public propertyscale
The scale factor.
(Inherited from GObject.)
Public propertyscaleX
The horizontal scale factor. '1' means no scale, cannt be negative.
(Inherited from GObject.)
Public propertyscaleY
The vertical scale factor. '1' means no scale, cannt be negative.
(Inherited from GObject.)
Public propertyscrollPane
ScrollPane of the component. If the component is not scrollable, the value is null.
Public propertysize
The size of the object in pixels.
(Inherited from GObject.)
Public propertyskew
(Inherited from GObject.)
Public propertysortingOrder
By default(when sortingOrder==0), object added to component is arrange by the added roder. The bigger is the sorting order, the object is more in front.
(Inherited from GObject.)
Public propertytext
(Inherited from GObject.)
Public propertytooltips
Tooltips of this object. UIConfig.tooltipsWin must be set first.
(Inherited from GObject.)
Public propertytouchable
If the object can touch or click. GImage/GTextField is not touchable even it is true.
(Inherited from GObject.)
Public propertyviewHeight
View port height of the container.
Public propertyviewWidth
Viwe port width of the container.
Public propertyvisible
The visibility of the object. An invisible object will be untouchable.
(Inherited from GObject.)
Public propertywidth
The width of the object in pixels.
(Inherited from GObject.)
Public propertyx
The x coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyxMin
(Inherited from GObject.)
Public propertyxy
The x and y coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyy
The y coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public propertyyMin
(Inherited from GObject.)
Public propertyz
The z coordinate of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Top
Methods
  NameDescription
Public methodAddChild
Add a child to the component. It will be at the frontmost position.
Public methodAddChildAt
Adds a child to the component at a certain index.
Public methodAddController
Adds a controller to the container.
Public methodAddEventListener(String, EventCallback0)
(Inherited from EventDispatcher.)
Public methodAddEventListener(String, EventCallback1)
(Inherited from EventDispatcher.)
Public methodAddRelation(GObject, RelationType)
(Inherited from GObject.)
Public methodAddRelation(GObject, RelationType, Boolean)
(Inherited from GObject.)
Public methodBroadcastEvent
(Inherited from EventDispatcher.)
Public methodBubbleEvent
(Inherited from EventDispatcher.)
Public methodCenter
Set the object in middle of the parent or GRoot if the parent is not set.
(Inherited from GObject.)
Public methodCenter(Boolean)
Set the object in middle of the parent or GRoot if the parent is not set.
(Inherited from GObject.)
Public methodConstructFromResource (Overrides GObjectConstructFromResource.)
Public methodConstructFromXML
Method for extensions to override
Public methodDispatchEvent(String)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(EventContext)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(String, Object)
(Inherited from EventDispatcher.)
Public methodDispatchEvent(String, Object, Object) (Inherited from EventDispatcher.)
Public methodDispose
Releases all resources used by the GComponent
(Overrides GObjectDispose.)
Public methodEnsureBoundsCorrect
Make sure the bounds of the component is correct. Bounds of the component is not updated on every changed. For example, you add a new child to the list, children in the list will be rearranged in next frame. If you want to access the correct child position immediatelly, call this function first.
Public methodGetChild
Returns a child object with a certain name.
Public methodGetChildAt
Returns a child object at a certain index. If index out of bounds, exception raised.
Public methodGetChildIndex
Returns the index of a child within the container, or "-1" if it is not found.
Public methodGetChildInGroup
Returns a child object belong to a group with a certain name.
Public methodGetChildren
Returns a copy of all children with an array.
Public methodGetController
Returns a controller object with a certain name.
Public methodGetControllerAt
Returns a controller object at a certain index.
Public methodGetFirstChildInView
Public methodGetGear (Inherited from GObject.)
Public methodGetTransition
Returns a transition object at a certain name.
Public methodGetTransitionAt
Returns a transition object at a certain index.
Public methodGetVisibleChild
Returns a visible child object with a certain name.
Public methodGlobalToLocal(Rect)
(Inherited from GObject.)
Public methodGlobalToLocal(Vector2)
Transforms a point from global (Stage) coordinates to the local coordinate system.
(Inherited from GObject.)
Public methodHandleControllerChanged (Overrides GObjectHandleControllerChanged(Controller).)
Public methodInvalidateBatchingState
Mark the fairy batching state is invalid.
(Inherited from GObject.)
Public methodInvalidateBatchingState(Boolean)
Public methodIsAncestorOf
Public methodIsChildInView
Test if a child is in view.
Public methodLocalToGlobal(Rect)
(Inherited from GObject.)
Public methodLocalToGlobal(Vector2)
Transforms a point from the local coordinate system to global (Stage) coordinates.
(Inherited from GObject.)
Public methodLocalToRoot
Transforms a point from the local coordinate system to GRoot coordinates.
(Inherited from GObject.)
Public methodMakeFullScreen
设置对象为全屏大小(逻辑屏幕)。
(Inherited from GObject.)
Public methodRemoveChild(GObject)
Removes a child from the component. If the object is not a child, nothing happens.
Public methodRemoveChild(GObject, Boolean)
Removes a child from the component. If the object is not a child, nothing happens.
Public methodRemoveChildAt(Int32)
Removes a child at a certain index. Children above the child will move down.
Public methodRemoveChildAt(Int32, Boolean)
Removes a child at a certain index. Children above the child will move down.
Public methodRemoveChildren
Remove all children.
Public methodRemoveChildren(Int32, Int32, Boolean)
Removes a range of children from the container (endIndex included).
Public methodRemoveController
Removes a controller from the container.
Public methodRemoveEventListener(String, EventCallback0)
(Inherited from EventDispatcher.)
Public methodRemoveEventListener(String, EventCallback1)
(Inherited from EventDispatcher.)
Public methodRemoveEventListeners
(Inherited from EventDispatcher.)
Public methodRemoveEventListeners(String)
(Inherited from EventDispatcher.)
Public methodRemoveFromParent
(Inherited from GObject.)
Public methodRemoveRelation
(Inherited from GObject.)
Public methodRequestFocus
Request focus on this object.
(Inherited from GObject.)
Public methodRootToLocal
Transforms a point from the GRoot coordinate to local coordinates system.
(Inherited from GObject.)
Public methodSetBoundsChangedFlag
Notify the component the bounds should recaculate.
Public methodSetChildIndex
Moves a child to a certain index. Children at and after the replaced position move up.
Public methodSetChildIndexBefore
Moves a child to a certain position which is in front of the child previously at given index. 与SetChildIndex不同的是,如果child原来在index的前面,那么child插入的位置是index-1,即保证排在原来占据index的对象的前面。
Public methodSetHome
(Inherited from GObject.)
Public methodSetPivot(Single, Single)
Change the x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public methodSetPivot(Single, Single, Boolean)
Change the x and y coordinates of the object's origin in its own coordinate space.
(Inherited from GObject.)
Public methodSetPosition
change the x,y,z coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public methodSetScale
Change the scale factor.
(Inherited from GObject.)
Public methodSetSize(Single, Single)
Change size.
(Inherited from GObject.)
Public methodSetSize(Single, Single, Boolean)
Change size.
(Inherited from GObject.)
Public methodSetup_AfterAdd (Overrides GObjectSetup_AfterAdd(ByteBuffer, Int32).)
Public methodSetup_BeforeAdd (Inherited from GObject.)
Public methodSetXY(Single, Single)
change the x and y coordinates of the object relative to the local coordinates of the parent.
(Inherited from GObject.)
Public methodSetXY(Single, Single, Boolean)
(Inherited from GObject.)
Public methodStartDrag
(Inherited from GObject.)
Public methodStartDrag(Int32)
(Inherited from GObject.)
Public methodStopDrag
(Inherited from GObject.)
Public methodSwapChildren
Swaps the indexes of two children.
Public methodSwapChildrenAt
Swaps the indexes of two children.
Public methodTransformPoint
(Inherited from GObject.)
Public methodTransformRect
(Inherited from GObject.)
Public methodTweenFade (Inherited from GObject.)
Public methodTweenMove (Inherited from GObject.)
Public methodTweenMoveX (Inherited from GObject.)
Public methodTweenMoveY (Inherited from GObject.)
Public methodTweenResize (Inherited from GObject.)
Public methodTweenRotate (Inherited from GObject.)
Public methodTweenScale (Inherited from GObject.)
Public methodTweenScaleX (Inherited from GObject.)
Public methodTweenScaleY (Inherited from GObject.)
Public methodWorldToLocal(Vector3)
(Inherited from GObject.)
Public methodWorldToLocal(Vector3, Camera)
(Inherited from GObject.)
Top
Fields
  NameDescription
Public fielddata
User defined data.
(Inherited from GObject.)
Public fielddragBounds
Restricted range of dragging.
(Inherited from GObject.)
Public fieldinitHeight
The initial height of the object.
(Inherited from GObject.)
Public fieldinitWidth
The initial width of the object.
(Inherited from GObject.)
Public fieldmaxHeight
(Inherited from GObject.)
Public fieldmaxWidth
(Inherited from GObject.)
Public fieldminHeight
(Inherited from GObject.)
Public fieldminWidth
(Inherited from GObject.)
Public fieldname
Name of the object.
(Inherited from GObject.)
Public fieldpackageItem
(Inherited from GObject.)
Public fieldsourceHeight
The source height of the object.
(Inherited from GObject.)
Public fieldsourceWidth
The source width of the object.
(Inherited from GObject.)
Top
See Also
Inheritance Hierarchy