3DRadSpace  v1.0.0a
Scripting documentation
_3DRadSpaceDll.Skybox Class Reference

Represents an Skybox object. More...

Inheritance diagram for _3DRadSpaceDll.Skybox:

Public Member Functions

 Skybox ()
 Empty constructor. More...
 Skybox (string name, bool enabled, string path)
 Main skybox constructor. More...
void Load (ContentManager content, GraphicsDevice gd)
 Loads the skybox. More...
override void Draw (SpriteBatch spriteBatch, Matrix? view, Matrix? projection)
 Draws the skybox. More...
void EditorDraw (Vector3 editor_cam_pos, Matrix view, Matrix projection)
 Draws the skybox in the editor - an extra argument is needed. More...
void LinkAvalableCamera ()
 Finds a camera object to link the skybox to. More...
void Dispose ()
 Frees the loaded texture. More...
- Public Member Functions inherited from _3DRadSpaceDll.GameObject
 GameObject ()
 Default constructor. More...
void Enable ()
 Enables object. More...
void Disable ()
 Disables object. More...
void Toggle ()
 Switches object on/off state. More...
void Show ()
 Shows the object. More...
void Hide ()
 Hides the object. More...
virtual void Load (ContentManager content)
 Loads the resource(s). More...
virtual void EditorDraw (SpriteBatch spriteBatch, Matrix? view, Matrix? projection)
 Object draw code for the 3DRadSpace editor More...
virtual void Update (MouseState mouse, KeyboardState keyboard, GameTime time)
 Object update logic More...
virtual void Trigger ()
 This is specific to objects like ExitFade, NetServer,etc More...
override bool Equals (object obj)
 Determines whether the specified object is equal to the current object. More...
override int GetHashCode ()
 Returns the hash code calculated from a string representing the data inside the object. More...
override string ToString ()
 Returns the object's name More...
void RunOnce ()
 Runs the object one Update loop. If used on a active object it will be stopped. More...

Public Attributes

Texture2D Texture
 A antire image representing the skybox. More...
- Public Attributes inherited from _3DRadSpaceDll.GameObject
Vector3 Position
 Object position More...
Vector3 Rotation
 Rotation in a Euler angles system. More...
List< int > SelectedObjects
 Used for editor. More...

Protected Member Functions

void Dispose (bool disposing)
 Protected Dispose(). More...


float Size [get, set]
 Size of the cube itself. More...
- Properties inherited from _3DRadSpaceDll.GameObject
string Name [get, set]
 Object Name. Used as a string identifier. More...
object Tag [get, set]
 Tag object. More...
bool Enabled [get, set]
 Checks if object is enabled. More...
bool Hidden [get, set]
 Checks if object is being drawn. More...
List< ObjectBehiavourBehiavours [get, set]
 Relation with other objects More...
Quaternion RotationQuaternion [get]
 Rotation in a Quaterion system. More...
string Resource [get, set]
 Resource file More...

Additional Inherited Members

- Static Public Member Functions inherited from _3DRadSpaceDll.GameObject
static implicit operator bool (GameObject o)
 Checks if the object exists. Same as GameObject != null. More...
static bool operator== (GameObject a, GameObject b)
 Checks if two GameObjects are equal. More...
static bool operator!= (GameObject a, GameObject b)
 The opposite of the equality operator. More...
- Events inherited from _3DRadSpaceDll.GameObject
onDraw OnDraw
 Called when object is being drawn on frame. More...
onUpdate OnUpdate
 Called when object is being updated on the update logic loop. More...
onObjectDestroy OnRemoval
 Called when object is being deleted. More...
onObjectLoad OnObjectLoad
 Called when a object resource is being loaded. More...

Detailed Description

Represents an Skybox object.

Constructor & Destructor Documentation

◆ Skybox() [1/2]

_3DRadSpaceDll.Skybox.Skybox ( )

Empty constructor.

◆ Skybox() [2/2]

_3DRadSpaceDll.Skybox.Skybox ( string  name,
bool  enabled,
string  path 

Main skybox constructor.


Member Function Documentation

◆ Dispose() [1/2]

void _3DRadSpaceDll.Skybox.Dispose ( )

Frees the loaded texture.

◆ Dispose() [2/2]

void _3DRadSpaceDll.Skybox.Dispose ( bool  disposing)

Protected Dispose().


◆ Draw()

override void _3DRadSpaceDll.Skybox.Draw ( SpriteBatch  spriteBatch,
Matrix?  view,
Matrix?  projection 

Draws the skybox.


Reimplemented from _3DRadSpaceDll.GameObject.

◆ EditorDraw()

void _3DRadSpaceDll.Skybox.EditorDraw ( Vector3  editor_cam_pos,
Matrix  view,
Matrix  projection 

Draws the skybox in the editor - an extra argument is needed.


◆ LinkAvalableCamera()

void _3DRadSpaceDll.Skybox.LinkAvalableCamera ( )

Finds a camera object to link the skybox to.

◆ Load()

void _3DRadSpaceDll.Skybox.Load ( ContentManager  content,
GraphicsDevice  gd 

Loads the skybox.

gdGraphicsDevice used to initialize the texture.

Member Data Documentation

◆ Texture

Texture2D _3DRadSpaceDll.Skybox.Texture

A antire image representing the skybox.

Property Documentation

◆ Size

float _3DRadSpaceDll.Skybox.Size

Size of the cube itself.