Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Encapsulates composition of a renderable frame, used by many GuiControls.

Namespace: Visual3D.UI
Assembly: Visual3D.UI (in Visual3D.UI.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

public class RenderableFrame : RenderableElement

Public Class RenderableFrame _
	Inherits RenderableElement

Members


	All Members			Constructors			Properties			Methods

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	RenderableFrame()()()()	Initializes a new instance of the RenderableFrame class
	BottomEdgeImage	Image used for Bottom Edge of Frame.
	BottomLeftImage	Image used for Bottom Left Corner of Frame.
	BottomRightImage	Image used for Bottom Left Corner of Frame.
	Colors	Get the rendering colors set for this RenderableElement. (Inherited from RenderableElement.)
	Draw(Vector3, ScreenRectangle)	Draw the element chain starting with this element. (Inherited from RenderableElement.)
	LeftEdgeImage	Image used for Left Edge Corner of Frame.
	NextElement	Get/Set another REnderableElement to this one. (Inherited from RenderableElement.)
	Position	Get/Set the offset position of this RenderableElement. (Inherited from RenderableElement.)
	Rect	Get/Set the area for the element. (Inherited from RenderableElement.)
	RightEdgeImage	Image used for Right Edge of Frame.
	RotationAngle	Get/Set the rotation for the element. (Inherited from RenderableElement.)
	SetColors(ColorRect)	Sets the colors to be applied when rendering the element. (Inherited from RenderableElement.)
	SetColors(VColor, VColor, VColor, VColor)	Sets the colors to be applied when rendering the element. (Inherited from RenderableElement.)
	SetImages(Image, Image, Image, Image, Image, Image, Image, Image)	Specify the Image objects to use for each part of the frame.
	Size	Get/Set the size of this element. (Inherited from RenderableElement.)
	TopEdgeImage	Image used for Top Edge of Frame.
	TopLeftImage	Image used for Top Left Corner of Frame.
	TopRightImage	Image used for Top Right Corner of Frame.

Remarks

This class is intended to be used where a (usually top-level) GUI element needs to draw a frame that is constructed from a collection of Images. It is possible to specify the image to use for each of the four corners, which are placed appropriately at their natural size, and the images for the four edges, which are stretched to cover the area between any corner images. Any of the Images may be omitted, in which case that part of the frame is not drawn. If the GUI element uses only one image for its frame (usually stretched over the entire area of the element) then a better choice would be to use a RenderableImage, or perform the rendering directly instead.

Inheritance Hierarchy

System..::..Object
Visual3D.UI..::..RenderableElement
Visual3D.UI..::..RenderableFrame

Syntax

Members

Remarks

Inheritance Hierarchy

See Also