NcEngine
Public Member Functions | Public Attributes | List of all members
nc::WireframeRenderer Struct Reference

Component for rendering wireframe models. More...

#include <WireframeRenderer.h>

Public Member Functions

 WireframeRenderer (WireframeSource source_, Entity target_, const Vector4 &color_=Vector4{0.9f, 0.25f, 0.9f, 1.0f}) noexcept
 
 WireframeRenderer (asset::MeshView mesh_, std::vector< DirectX::XMMATRIX > instances_, const Vector4 &color_=Vector4{0.9f, 0.25f, 0.9f, 1.0f}) noexcept
 

Public Attributes

WireframeSource source
 
Entity target
 
asset::MeshView mesh
 
std::vector< DirectX::XMMATRIX > instances
 
Vector4 color
 

Detailed Description

Component for rendering wireframe models.

When 'source' is set to WireframeSource::Internal, the members 'mesh' and 'instances' will be used to render N wireframes, where N is the size of 'instances'. The 'target' member is unused.

When 'source' is set to WireframeSource::Renderer, the underlying mesh of the MeshRenderer or ToonRenderer attached to 'target' will be used to render a wireframe. If 'target' does not contain either of these, the default cube mesh will be used. The rendered position is based on 'target'.

When 'source' is set to WireframeSource::Collider, the underlying geometry of the Collider attached to 'target' will be used to render a wireframe. If 'target' does not contain a Collider, 'target' will be set to Entity::Null() during the next pass of ExecutionPhase::Render. The rendered position is based on 'target'.

In either 'Renderer' or 'Collider' source modes, 'target' may be set to the WireframeRenderer's parent Entity or another Entity. If 'target' no longer refers to a valid Entity, it will be set to Entity::Null() during the next pass of ExecutionPhase::Render.

The documentation for this struct was generated from the following file: