Angulos
Loading...
Searching...
No Matches
Angulos._3d.Components.RenderComponents.RigidRenderComponent Class Reference

A component that renders a rigid body object. More...

Inheritance diagram for Angulos._3d.Components.RenderComponents.RigidRenderComponent:
Angulos._3d.Components.IAngulosComponent Angulos._3d.Components.RenderComponents.IRenderComponent Angulos._3d.Components.IAngulosComponent

Public Member Functions

void Destroy ()
 Stop rendering the object. This is not the same as disabling the component, as the component will not still be active.
void Disable ()
 Stop rendering the object. This is not the saem as destroying the object, as the object will still be active.
void Start ()
 Start rendering the object.
void TickCall ()
 Called every frame. Currently does nothing.
void HandleDrawing (ref InternalSVKRenderer renderer)
 Called every frame. Currently does nothing.
void UpdateCommandBufferRecorder ()
 Updates a command buffer recorder for the object. This is necessary if the mesh or texture changes.
void OnRendererInitialized ()
 Initializes the renderer for the component.
void OnObjectRenderInitialized ()
 Currently does nothing.
Public Member Functions inherited from Angulos._3d.Components.IAngulosComponent
void UpdateCall ()
 Called every [UpdateTiming] frames.
void ParentMeshUpdate ()
 Called when a the parent mesh changes.
void FrameIndependentUpdate ()
 Called every [FrameIndependentUpdateTiming] units of time. Will be constant, even if a the renderer is frozen. This should not be overused.

Properties

ushort calls [get, set]
 See IAngulosComponent.calls.
bool Working [get, set]
 See IAngulosComponent.Working.
ushort UpdateTiming [get, set]
 See IAngulosComponent.UpdateTiming.
TimeSpan FrameIndependentUpdateTiming [get, set]
 See IAngulosComponent.FrameIndependentUpdateTiming.
SimulatedObject Parent [get, set]
 The parent object of the component.
InternalSVKRenderer AssociatedRenderer [get, set]
 The renderer to render to.
SVKObject AssociatedRenderObject [get, set]
 The associated object to render.
bool HasBeenInitialized [get, set]
 If the component has been initialized. If false, the ECS will call Start() on the component.
bool EnableFrameIndependentUpdate = false [get, set]
 If frame independant updates should be performed. This should only be used for time-sensitive components like animation.

Detailed Description

A component that renders a rigid body object.

Member Function Documentation

◆ Destroy()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.Destroy ( )
inline

Stop rendering the object. This is not the same as disabling the component, as the component will not still be active.

Implements Angulos._3d.Components.IAngulosComponent.

◆ Disable()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.Disable ( )
inline

Stop rendering the object. This is not the saem as destroying the object, as the object will still be active.

Implements Angulos._3d.Components.IAngulosComponent.

◆ HandleDrawing()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.HandleDrawing ( ref InternalSVKRenderer renderer)
inline

Called every frame. Currently does nothing.

Parameters
renderer

◆ OnObjectRenderInitialized()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.OnObjectRenderInitialized ( )
inline

Currently does nothing.

Implements Angulos._3d.Components.RenderComponents.IRenderComponent.

◆ OnRendererInitialized()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.OnRendererInitialized ( )
inline

Initializes the renderer for the component.

Implements Angulos._3d.Components.RenderComponents.IRenderComponent.

◆ Start()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.Start ( )
inline

Start rendering the object.

Implements Angulos._3d.Components.IAngulosComponent.

◆ TickCall()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.TickCall ( )
inline

Called every frame. Currently does nothing.

Implements Angulos._3d.Components.IAngulosComponent.

◆ UpdateCommandBufferRecorder()

void Angulos._3d.Components.RenderComponents.RigidRenderComponent.UpdateCommandBufferRecorder ( )
inline

Updates a command buffer recorder for the object. This is necessary if the mesh or texture changes.

Implements Angulos._3d.Components.RenderComponents.IRenderComponent.

Property Documentation

◆ calls

ushort Angulos._3d.Components.RenderComponents.RigidRenderComponent.calls
getset

◆ EnableFrameIndependentUpdate

bool Angulos._3d.Components.RenderComponents.RigidRenderComponent.EnableFrameIndependentUpdate = false
getset

If frame independant updates should be performed. This should only be used for time-sensitive components like animation.

Implements Angulos._3d.Components.IAngulosComponent.

◆ FrameIndependentUpdateTiming

TimeSpan Angulos._3d.Components.RenderComponents.RigidRenderComponent.FrameIndependentUpdateTiming
getset

◆ HasBeenInitialized

bool Angulos._3d.Components.RenderComponents.RigidRenderComponent.HasBeenInitialized
getset

If the component has been initialized. If false, the ECS will call Start() on the component.

Implements Angulos._3d.Components.IAngulosComponent.

◆ Parent

SimulatedObject Angulos._3d.Components.RenderComponents.RigidRenderComponent.Parent
getset

The parent object of the component.

Implements Angulos._3d.Components.IAngulosComponent.

◆ UpdateTiming

ushort Angulos._3d.Components.RenderComponents.RigidRenderComponent.UpdateTiming
getset

◆ Working

bool Angulos._3d.Components.RenderComponents.RigidRenderComponent.Working
getset

The documentation for this class was generated from the following file:
  • Sharp/_3d/Components/RenderComponents/RigidRenderComponent.cs