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

Asterisk Class Reference

#include <Asterisk.h>

Inheritance diagram for Asterisk:
Wireframe

# Public Types

typedef const AsteriskSpec AsteriskROMSpec

# Public Member Functions

void constructor (Entity owner, const AsteriskSpec *asteriskSpec)
override void render (Vector3D relativePosition)
override bool draw ()

# Protected Attributes

PixelVector position
 Position at which to draw the wireframe.
fixed_t length
 Length of the asterisk's lines.
uint16 scaledLength
 Used length of the asterisk's lines to draw them.

# 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 Asterisk

Inherits from Wireframe

Draws an asterisk.

Definition at line 48 of file Asterisk.h.

# Member Typedef Documentation

# AsteriskROMSpec

typedef const AsteriskSpec AsteriskROMSpec

A Asterisk spec that is stored in ROM

Definition at line 37 of file Asterisk.h.

# Member Function Documentation

# constructor()

void Asterisk::constructor ( Entity owner,
const AsteriskSpec * asteriskSpec )

Class' constructor

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

Definition at line 25 of file Asterisk.c.

# draw()

bool Asterisk::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 56 of file Asterisk.c.

# render()

void Asterisk::render ( Vector3D relativePosition)
virtual

Prepare the wireframe for drawing.

Parameters
relativePositionPosition relative to the camera's

Reimplemented from Wireframe.

Definition at line 45 of file Asterisk.c.

# Member Data Documentation

# length

fixed_t Asterisk::length
protected

Length of the asterisk's lines.

Definition at line 56 of file Asterisk.h.

# position

PixelVector Asterisk::position
protected

Position at which to draw the wireframe.

Definition at line 53 of file Asterisk.h.

# scaledLength

uint16 Asterisk::scaledLength
protected

Used length of the asterisk's lines to draw them.

Definition at line 59 of file Asterisk.h.


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