HPS::Glyph Class Reference

#include <hps.h>

Public Types

enum  ColorSource : uint32_t { ColorSource::Default, ColorSource::Explicit, ColorSource::Indexed }
 
enum  Default : uint32_t {
  Default::Circle, Default::CircleWithDot, Default::CircleWithPlus, Default::CircleWithTimes,
  Default::CircleWithCircle, Default::SolidCircle, Default::Dot, Default::Plus,
  Default::Times, Default::Splat, Default::Box, Default::BoxWithDot,
  Default::BoxWithTimes, Default::SolidBox, Default::Diamond, Default::DiamondWithDot,
  Default::DiamondWithPlus, Default::SolidDiamond, Default::TriangleUp, Default::TriangleUpWithDot,
  Default::SolidTriangleUp, Default::TriangleDown, Default::TriangleDownWithDot, Default::SolidTriangleDown,
  Default::TriangleRight, Default::TriangleRightWithDot, Default::SolidTriangleRight, Default::TriangleLeft,
  Default::TriangleLeftWithDot, Default::SolidTriangleLeft, Default::TriangleUpV, Default::SolidTriangleUpV,
  Default::TriangleDownV, Default::SolidTriangleDownV, Default::TriangleRightV, Default::SolidTriangleRightV,
  Default::TriangleLeftV, Default::SolidTriangleLeftV, Default::LetterY, Default::LetterZ,
  Default::CircleLetterY, Default::CircleLetterZ, Default::VerticalBar, Default::HorizontalBar,
  Default::SlantLeft, Default::SlantRight, Default::WidePlus, Default::SolidWidePlus,
  Default::WideTimes, Default::SolidWideTimes, Default::Pound, Default::Sphere
}





 
enum  Fill : uint32_t { Fill::None, Fill::Continuous, Fill::New, Fill::NewLoop }
 

Detailed Description

The Glyph class is a concept class for glyph-related enum classes.

Member Enumeration Documentation

◆ ColorSource

enum HPS::Glyph::ColorSource : uint32_t
strong

Enumerates the color modes that can apply to glyph elements.

Enumerator
Default 

Glyph element color will be inherited from the color of the owning geometry.

Explicit 

Glyph element color will be the specified RGBA color.

Indexed 

Glyph element color will be the color at the specified index in the effective material palette.

◆ Default

enum HPS::Glyph::Default : uint32_t
strong

Enumerates the predefined glyphs in Visualize. These can be accessed via the GlyphKit::GetDefault function and their appearance can be seen here.

Enumerator
Circle 

An unfilled circle.

CircleWithDot 

An unfilled circle with a dot in the center.

CircleWithPlus 

An unfilled circle with a plus sign in the center.

CircleWithTimes 

An unfilled circle with a times sign (X-shaped) in the center.

CircleWithCircle 

An unfilled circle with a smaller unfilled circle inside it.

SolidCircle 

A filled circle.

Dot 

A single dot.

Plus 

A plus sign.

Times 

A times sign (X-shaped).

Splat 

An asterisk (an X shape with an additional horizonatal line through the intersection point).

Box 

An unfilled square.

BoxWithDot 

An unfilled square with a dot in the center.

BoxWithTimes 

An unfilled square with a times sign (X-shaped) in the center.

SolidBox 

A filled square.

Diamond 

An unfilled diamond.

DiamondWithDot 

An unfilled diamond with a dot in the center.

DiamondWithPlus 

An unfilled diamond with a plus sign in the center.

SolidDiamond 

A filled diamond.

TriangleUp 

An unfilled upward-pointing triangle.

TriangleUpWithDot 

An unfilled upward-pointing triangle with a dot in the center.

SolidTriangleUp 

A filled upward-pointing triangle.

TriangleDown 

An unfilled downward-pointing triangle.

TriangleDownWithDot 

An unfilled downward-pointing triangle with a dot in the center.

SolidTriangleDown 

A filled downward-pointing triangle.

TriangleRight 

An unfilled rightward-pointing triangle.

TriangleRightWithDot 

An unfilled rightward-pointing triangle with a dot in the center.

SolidTriangleRight 

A filled rightward-pointing triangle.

TriangleLeft 

An unfilled leftward-pointing triangle.

TriangleLeftWithDot 

An unfilled leftward-pointing triangle with a dot in the center.

SolidTriangleLeft 

A filled leftward-pointing triangle.

TriangleUpV 

An unfilled upward-pointing triangle with the top vertex at the glyph canvas origin.

SolidTriangleUpV 

A filled upward-pointing triangle with the top vertex at the glyph canvas origin.

TriangleDownV 

An unfilled downward-pointing triangle with the bottom vertex at the glyph canvas origin.

SolidTriangleDownV 

A filled downward-pointing triangle with the bottom vertex at the glyph canvas origin.

TriangleRightV 

An unfilled rightward-facing triangle with the right vertex at the glyph canvas origin.

SolidTriangleRightV 

A filled rightward-facing triangle with the right vertex at the glyph canvas origin.

TriangleLeftV 

An unfilled leftward-facing triangle with the left vertex at the glyph canvas origin.

SolidTriangleLeftV 

A filled leftward-facing triangle with the left vertex at the glyph canvas origin.

LetterY 

The letter Y.

LetterZ 

The letter Z.

CircleLetterY 

The letter Y circumscribed in an unfilled circle.

CircleLetterZ 

The letter Z circumscribed in an unfilled circle.

VerticalBar 

A vertical bar.

HorizontalBar 

A horizontal bar.

SlantLeft 

A left-slanting bar.

SlantRight 

A right-slanting bar.

WidePlus 

An unfilled plus sign.

SolidWidePlus 

A filled plus sign.

WideTimes 

An unfilled times sign (X-shaped).

SolidWideTimes 

A filled times sign (X-shaped).

Pound 

Two parallel vertical bars intersecting two parallel horizontal bars.

Sphere 

A phong-shaded sphere when vertex lighting is enabled on supported drivers. A solid circle in all other cases.

◆ Fill

enum HPS::Glyph::Fill : uint32_t
strong

Enumerates the fill modes that can apply to glyph elements.

Enumerator
None 

Closed geometry will not be filled.

Continuous 

Closed geometry will be filled. If previous geometry was already filled, the fill will be be continued.

New 

Closed geometry will be filled. If previous geometry was already filled, the fill will be restarted.

NewLoop 

Closed geometry will be filled. If previous geometry was already filled, the fill will be continued as a new loop (such as a hole).


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