OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Package Functions | Properties | List of all members
OmegaEngine.Graphics.Renderables.Model Class Reference

A model (stored as a Direct3DX Mesh with one or more subsets). Handle More...

Inheritance diagram for OmegaEngine.Graphics.Renderables.Model:
OmegaEngine.Graphics.Renderables.PositionableRenderable OmegaEngine.Graphics.Renderables.Renderable OmegaEngine.IPositionableOffset OmegaEngine.EngineElement OmegaEngine.IResetable OmegaEngine.IPositionable OmegaEngine.Graphics.Renderables.FloatingModel OmegaEngine.Graphics.Renderables.Terrain OmegaEngine.Graphics.Renderables.Water

Public Member Functions

void SetTexture (ITextureProvider texture)
 Sets the first diffuse texture of the first material. More...
 
 Model (XMesh mesh)
 Creates a new model based upon a XMesh, using its internal material data if available. More...
 
 Model (XMesh mesh, params XMaterial[] materials)
 Creates a new model based upon a XMesh, using an external texture and a plain white material. More...
 
 Model (Mesh mesh, params XMaterial[] materials)
 Creates a new model based upon a custom mesh. More...
 
override bool Intersects (Ray ray, out float distance)
 Determine whether this PositionableRenderable is intersected by a ray.
Parameters
rayA ray in world space along which to check for intersections.
distanceReturns the distance along the ray at which the intersection took place.
Returns
true if this PositionableRenderable was intersected by the ray .
See Also
View.Pick

 
- Public Member Functions inherited from OmegaEngine.Graphics.Renderables.PositionableRenderable
void SetScale (float factor)
 Scales this PositionableRenderable symmetrically More...
 
bool IsVisible (Camera camera)
 Checks whether this object is visible at the moment (includes Frustum Culling and other filtering criteria). More...
 
bool Intersects (Ray ray, out DoubleVector3 position)
 Determine whether this PositionableRenderable is intersected by a ray. More...
 
- Public Member Functions inherited from OmegaEngine.Graphics.Renderables.Renderable
override string ToString ()
 
- Public Member Functions inherited from OmegaEngine.EngineElement
void Dispose ()
 

Static Public Member Functions

static Model Quad (Engine engine, ITextureProvider texture=null, float width=5, float height=5)
 Creates a model of a textured 2D quad. More...
 
static Model Box (Engine engine, ITextureProvider texture=null, float width=5, float height=5, float depth=5)
 Creates a model of a textured box. More...
 
static Model Sphere (Engine engine, ITextureProvider texture=null, float radius=10, int slices=20, int stacks=20)
 Creates a model of a textured sphere with spherical mapping. More...
 
static Model Cylinder (Engine engine, ITextureProvider texture, float radiusBottom, float radiusTop, float length, int slices, int stacks)
 Creates a model of a textured sphere with spherical mapping. More...
 
static Model Cylinder (Engine engine, ITextureProvider texture=null, float radiusBottom=1, float radiusTop=1, float length=10)
 Creates a model of a textured cylinder with spherical mapping. More...
 
static Model Disc (Engine engine, ITextureProvider texture, float radiusInner, float radiusOuter, float height, int segments)
 Creates a model of a textured round disc with a hole in the middle. More...
 
static Model Disc (Engine engine, ITextureProvider texture=null, float radiusInner=5, float radiusOuter=7, float height=1)
 Creates a model of a textured round disc with a hole in the middle. More...
 

Public Attributes

readonly XMaterial[] Materials
 An array of materials used to render this mesh More...
 
int VertexCount => Mesh.VertexCount
 The numbers of vertexes in this model More...
 
- Public Attributes inherited from OmegaEngine.Graphics.Renderables.PositionableRenderable
ICollection< ViewRequiredViews => _requiredViews
 A list of Views that must be rendered before this PositionableRenderable can be rendered More...
 
- Public Attributes inherited from OmegaEngine.EngineElement
bool IsEngineSet => _engine != null
 true if the Engine has been set. More...
 

Protected Member Functions

void RenderSubset (int i, Camera camera, LightSource[] lights)
 
override void OnDispose ()
 Hook that is called when the object needs to dispose its internal resources.
 
- Protected Member Functions inherited from OmegaEngine.Graphics.Renderables.PositionableRenderable
virtual void RecalcWorldTransform ()
 Called to generate/update transformation matrices and related values More...
 
void RenderHelper (Action render, XMaterial material, Camera camera, params LightSource[] lights)
 Provides an automatic rendering framework that handles things like setting textures, materials, lighting and shaders. More...
 
virtual bool IntersectsBounding (Ray ray)
 Determine whether PositionableRenderable.WorldBoundingBox and PositionableRenderable.WorldBoundingSphere (if defined) are intersected by a ray. More...
 
override void OnEngineSet ()
 Hook that is calld when Engine is set for the first time.
 
- Protected Member Functions inherited from OmegaEngine.Graphics.Renderables.Renderable
virtual void OnPreRender ()
 
void PrepareRender ()
 Should be called before rendering anything - usually called by base constructor More...
 
- Protected Member Functions inherited from OmegaEngine.EngineElement
void RegisterChild (EngineElement element, bool autoDispose=true)
 Registers a child EngineElement for automatic Engine setting and Dispose calling. More...
 
void UnregisterChild (EngineElement element)
 Unregisters a child EngineElement (opposite of RegisterChild). More...
 

Protected Attributes

readonly Mesh Mesh
 The mesh object to use for rendering; never null. More...
 
- Protected Attributes inherited from OmegaEngine.Graphics.Renderables.PositionableRenderable
bool WorldTransformDirty = true
 Does the world transform need to be recalculated? More...
 

Package Functions

override void Render (Camera camera, GetLights getLights=null)
 To be called when this object ist to be rendered.
Parameters
cameraSupplies information for the view transformation.
getLightsA delegate that will be called to get lighting information.

 
- Package Functions inherited from OmegaEngine.Graphics.Renderables.PositionableRenderable
override void Render (Camera camera, GetLights getLights=null)
 To be called when this object ist to be rendered.
Parameters
cameraSupplies information for the view transformation.
getLightsA delegate that will be called to get lighting information.

 

Properties

int NumberSubsets [get, set]
 The numbers of subsets in this model More...
 
- Properties inherited from OmegaEngine.Graphics.Renderables.PositionableRenderable
bool Pickable [get, set]
 Shall this PositionableRenderable be pickable with the mouse? More...
 
ViewType RenderIn = true [get, set]
 In what kind of Views shall this body be rendered? More...
 
SurfaceEffect SurfaceEffect [get, set]
 What kinds of surface effects (e.g. lighting) to apply to this PositionableRenderable More...
 
SurfaceShader SurfaceShader [get, set]
 The SurfaceShader to apply to the surface of this PositionableRenderable More...
 
BillboardMode Billboard [get, set]
 How this PositionableRenderable shall be rotated towards the camera More...
 
Matrix PreTransform [get, set]
 A transformation matrix that is to be applied before the normal world transform occurs - useful for correcting off-center meshes More...
 
Vector3 Scale [get, set]
 Scaling to be performed before rendering More...
 
Quaternion Rotation [get, set]
 The body's rotation quaternion More...
 
DoubleVector3 Position [get, set]
 The body's position in world space More...
 
Matrix WorldTransform [get]
 The world transformation matrix for this entity More...
 
Matrix InverseWorldTransform [get]
 The world transformation matrix for this entity More...
 
double CurrentCameraDistance [get]
 The body's current distance to View.Camera calculated from IPositionableOffset.EffectivePosition More...
 
BoundingSphere BoundingSphere [get, set]
 A sphere that completely encompasses the body (in entity space, even before apply PreTransform). More...
 
BoundingSphere WorldBoundingSphere [get]
 A sphere that completely encompasses the body (in world space, used for culling tests). More...
 
bool DrawBoundingSphere [get, set]
 Shall the bounding sphere used to cull this object be drawn/visualized? (used for debugging) More...
 
BoundingBox BoundingBox [get, set]
 A axis-aligned box that completely encompasses the body (in entity space, even before apply PreTransform). More...
 
BoundingBox WorldBoundingBox [get]
 An axis-aligned box that completely encompasses the body (in world space, used for culling tests). More...
 
bool DrawBoundingBox [get, set]
 Shall the bounding box used to cull this object be drawn/visualized? (used for debugging) More...
 
- Properties inherited from OmegaEngine.Graphics.Renderables.Renderable
int RenderCount [get, set]
 How many times has this entity been rendered in this frame? More...
 
string Name [get, set]
 Text value to make it easier to identify a particular render entity More...
 
bool Visible [get, set]
 Shall the entity be rendered? More...
 
bool Wireframe = true [get, set]
 Shall this entity be drawn in wireframe-mode? (used for debugging) More...
 
float VisibilityDistance [get, set]
 The maximum distance from which the entity is visible - 0 for infinite More...
 
int Alpha [get, set]
 The level of transparency from 0 (solid) to 255 (invisible), OmegaEngine.EngineState.AlphaChannel, OmegaEngine.EngineState.BinaryAlphaChannel or OmegaEngine.EngineState.AdditivBlending More...
 
- Properties inherited from OmegaEngine.EngineElement
Engine Engine [get, set]
 The Engine instance used by this object. Must be set before using the object. May not be changed once it has been set! More...
 
bool IsDisposed [get, set]
 Indicates whether this object has been disposed and can therefore no longer be used. More...
 
- Properties inherited from OmegaEngine.IPositionableOffset
DoubleVector3 Offset [get, set]
 A value to be subtracted from IPositionable.Position in order gain IPositionableOffset.EffectivePosition More...
 
Vector3 EffectivePosition [get]
 The sum of IPositionable.Position and IPositionableOffset.EffectivePosition More...
 
- Properties inherited from OmegaEngine.IPositionable
DoubleVector3 Position [get, set]
 The object's position More...
 

Additional Inherited Members

- Events inherited from OmegaEngine.Graphics.Renderables.Renderable
Action PreRender
 Occurs once per frame before rendering the entity. Will not be executed if the entity is excluded by a culling test. More...
 

Detailed Description

A model (stored as a Direct3DX Mesh with one or more subsets). Handle

No custom PrimitiveTypes. Use VertexGroup for that.

Constructor & Destructor Documentation

OmegaEngine.Graphics.Renderables.Model.Model ( XMesh  mesh)
inline

Creates a new model based upon a XMesh, using its internal material data if available.

Parameters
meshThe XMesh providing the mesh data.

Calling IDisposable.Dispose will not dispose the mesh . This is handled by the CacheManager.

OmegaEngine.Graphics.Renderables.Model.Model ( XMesh  mesh,
params XMaterial[]  materials 
)
inline

Creates a new model based upon a XMesh, using an external texture and a plain white material.

Parameters
meshThe XMesh providing the mesh data.
materialsThe materials to use for rendering the model.

Calling IDisposable.Dispose will call IReferenceCount.ReleaseReference on mesh and materials .

OmegaEngine.Graphics.Renderables.Model.Model ( Mesh  mesh,
params XMaterial[]  materials 
)
inline

Creates a new model based upon a custom mesh.

Parameters
meshThe mesh to render. Normals should be calculated before-hand if they will be used (e.g. by SurfaceShaders).
materialsThe materials to use for rendering the model.

Calling IDisposable.Dispose will call IDisposable.Dispose on mesh and IReferenceCount.ReleaseReference on materials .

Member Function Documentation

static Model OmegaEngine.Graphics.Renderables.Model.Box ( Engine  engine,
ITextureProvider  texture = null,
float  width = 5,
float  height = 5,
float  depth = 5 
)
inlinestatic

Creates a model of a textured box.

Parameters
engineThe Engine to use for rendering.
textureThe texture to place on the model; null for no texture.
widthThe width of the box
heightThe height of the box
depthThe depth of the box
static Model OmegaEngine.Graphics.Renderables.Model.Cylinder ( Engine  engine,
ITextureProvider  texture,
float  radiusBottom,
float  radiusTop,
float  length,
int  slices,
int  stacks 
)
inlinestatic

Creates a model of a textured sphere with spherical mapping.

Parameters
engineThe Engine to use for rendering.
textureThe texture to place on the model; null for no texture.
radiusBottomThe radius of the cylinder at the lower end (negative Z).
radiusTopThe radius of the cylinder at the upper end (positive Z).
lengthThe length of the cylinder.
slicesThe number of vertical slices to divide the cylinder in.
stacksThe number of horizontal stacks to divide the cylinder in.
static Model OmegaEngine.Graphics.Renderables.Model.Cylinder ( Engine  engine,
ITextureProvider  texture = null,
float  radiusBottom = 1,
float  radiusTop = 1,
float  length = 10 
)
inlinestatic

Creates a model of a textured cylinder with spherical mapping.

Parameters
engineThe Engine to use for rendering.
textureThe texture to place on the model; null for no texture.
radiusBottomThe radius of the cylinder at the lower end (negative Z).
radiusTopThe radius of the cylinder at the upper end (positive Z).
lengthThe length of the cylinder.
static Model OmegaEngine.Graphics.Renderables.Model.Disc ( Engine  engine,
ITextureProvider  texture,
float  radiusInner,
float  radiusOuter,
float  height,
int  segments 
)
inlinestatic

Creates a model of a textured round disc with a hole in the middle.

Parameters
engineThe Engine to use for rendering.
textureThe texture to place on the model; null for no texture.
radiusInnerThe radius of the inner circle of the ring.
radiusOuterThe radius of the outer circle of the ring.
heightThe height of the ring.
segmentsThe number of segments the ring shall consist of.
static Model OmegaEngine.Graphics.Renderables.Model.Disc ( Engine  engine,
ITextureProvider  texture = null,
float  radiusInner = 5,
float  radiusOuter = 7,
float  height = 1 
)
inlinestatic

Creates a model of a textured round disc with a hole in the middle.

Parameters
engineThe Engine to use for rendering.
textureThe texture to place on the model; null for no texture.
radiusInnerThe radius of the inner circle of the ring.
radiusOuterThe radius of the outer circle of the ring.
heightThe height of the ring.
static Model OmegaEngine.Graphics.Renderables.Model.Quad ( Engine  engine,
ITextureProvider  texture = null,
float  width = 5,
float  height = 5 
)
inlinestatic

Creates a model of a textured 2D quad.

Parameters
engineThe Engine to use for rendering.
textureThe texture to place on the model; null for no texture.
widthThe width of the quad.
heightThe height of the quad.
void OmegaEngine.Graphics.Renderables.Model.SetTexture ( ITextureProvider  texture)
inline

Sets the first diffuse texture of the first material.

Parameters
textureThe texture to set; null for no texture.
static Model OmegaEngine.Graphics.Renderables.Model.Sphere ( Engine  engine,
ITextureProvider  texture = null,
float  radius = 10,
int  slices = 20,
int  stacks = 20 
)
inlinestatic

Creates a model of a textured sphere with spherical mapping.

Parameters
engineThe Engine to use for rendering.
textureThe texture to place on the model; null for no texture.
radiusThe radius of the sphere.
slicesThe number of vertical slices to divide the sphere into.
stacksThe number of horizontal stacks to divide the sphere into.

Member Data Documentation

readonly XMaterial [] OmegaEngine.Graphics.Renderables.Model.Materials

An array of materials used to render this mesh

readonly Mesh OmegaEngine.Graphics.Renderables.Model.Mesh
protected

The mesh object to use for rendering; never null.

int OmegaEngine.Graphics.Renderables.Model.VertexCount => Mesh.VertexCount

The numbers of vertexes in this model

Property Documentation

int OmegaEngine.Graphics.Renderables.Model.NumberSubsets
getset

The numbers of subsets in this model


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