1. Home
  2. Documentation
  3. API
  4. Line Class Reference

Line Class Reference

#include <Line.h>

Inheritance diagram for Line:
Wireframe

# Public Types

typedef const LineSpec LineROMSpec

# Public Member Functions

void constructor (Entity owner, const LineSpec *lineSpec)
override void render (Vector3D relativePosition)
override bool draw ()

# Protected Attributes

PixelVector a
 Starting point.
PixelVector b
 End point.

# Additional Inherited Members

- Private Types inherited from Wireframe
typedef const WireframeSpec WireframeROMSpec
- Private Member Functions inherited from Wireframe
void constructor (Entity owner, const WireframeSpec *wireframeSpec)
void setDisplacement (Vector3D displacement)
bool isVisible ()
bool prepareForRender (Vector3D *relativePosition, const Vector3D *cameraDirection)
virtual VirtualList getVertices ()

# Detailed Description

Class Line

Inherits from Wireframe

Draws a line.

Definition at line 51 of file Line.h.

# Member Typedef Documentation

# LineROMSpec

typedef const LineSpec LineROMSpec

A Line spec that is stored in ROM

Definition at line 40 of file Line.h.

# Member Function Documentation

# constructor()

void Line::constructor ( Entity owner,
const LineSpec * lineSpec )

Class' constructor

Parameters
ownerEntity to which the wireframe attaches to
lineSpecSpecification that determines how to configure the wireframe

Definition at line 25 of file Line.c.

# draw()

bool Line::draw ( )
virtual

Draw the wireframe to the frame buffers.

Returns
True if at least one pixel is drawn; false otherwise

Implements Wireframe.

Definition at line 62 of file Line.c.

# render()

void Line::render ( Vector3D relativePosition)
virtual

Prepare the wireframe for drawing.

Parameters
relativePositionPosition relative to the camera's

Reimplemented from Wireframe.

Definition at line 44 of file Line.c.

# Member Data Documentation

# a

PixelVector Line::a
protected

Starting point.

Definition at line 56 of file Line.h.

# b

PixelVector Line::b
protected

End point.

Definition at line 59 of file Line.h.


The documentation for this class was generated from the following files:
  • VUEngine-Core/source/Component/VisualComponent/Wireframe/Line/Line.h
  • VUEngine-Core/source/Component/VisualComponent/Wireframe/Line/Line.c