Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Public Member Functions | Public Attributes | List of all members
Zivid::Point Class Reference

A 3D point with contrast and RGBA values More...

#include <Zivid/Point.h>

Public Member Functions

 Point ()
 Construct a 3D point at (0,0,0) with contrast 0 and color values (r,g,b,a) = (0,0,0,255) More...
 
void setNaN ()
 Invalidate the point (set it to Not-a-Number) More...
 
bool isNaN () const
 Check whether the point is valid (Not-a-Number) More...
 
void setRgba (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the r,g,b and alpha color value for the point More...
 
void setRgb (unsigned char r, unsigned char g, unsigned char b)
 Set the r,g,b color value for the point More...
 
void setIntensity (unsigned char val)
 Set the intensity for the point (sets r,g and b to identical values) More...
 
void setContrast (float value)
 Set the contrast for the point More...
 
unsigned char alpha () const
 Get the alpha value for the point More...
 
unsigned char red () const
 Get the red color value for the point More...
 
unsigned char green () const
 Get the green color value for the point More...
 
unsigned char blue () const
 Get the blue color value for the point More...
 
unsigned char intensity () const
 Get the intensity of the point More...
 

Public Attributes

float x
 X coordinate. More...
 
float y
 Y coordinate. More...
 
float z
 Z coordinate. More...
 
float contrast
 Contrast. More...
 
uint32_t rgba
 Color (red,green,blue,alpha) More...
 

Detailed Description

A 3D point with contrast and RGBA values

Constructor & Destructor Documentation

◆ Point()

Zivid::Point::Point ( )
inline

Construct a 3D point at (0,0,0) with contrast 0 and color values (r,g,b,a) = (0,0,0,255)

Member Function Documentation

◆ alpha()

unsigned char Zivid::Point::alpha ( ) const
inline

Get the alpha value for the point

◆ blue()

unsigned char Zivid::Point::blue ( ) const
inline

Get the blue color value for the point

◆ green()

unsigned char Zivid::Point::green ( ) const
inline

Get the green color value for the point

◆ intensity()

unsigned char Zivid::Point::intensity ( ) const
inline

Get the intensity of the point

◆ isNaN()

bool Zivid::Point::isNaN ( ) const
inline

Check whether the point is valid (Not-a-Number)

◆ red()

unsigned char Zivid::Point::red ( ) const
inline

Get the red color value for the point

◆ setContrast()

void Zivid::Point::setContrast ( float  value)
inline

Set the contrast for the point

◆ setIntensity()

void Zivid::Point::setIntensity ( unsigned char  val)
inline

Set the intensity for the point (sets r,g and b to identical values)

◆ setNaN()

void Zivid::Point::setNaN ( )
inline

Invalidate the point (set it to Not-a-Number)

◆ setRgb()

void Zivid::Point::setRgb ( unsigned char  r,
unsigned char  g,
unsigned char  b 
)
inline

Set the r,g,b color value for the point

◆ setRgba()

void Zivid::Point::setRgba ( unsigned char  r,
unsigned char  g,
unsigned char  b,
unsigned char  a 
)
inline

Set the r,g,b and alpha color value for the point

Member Data Documentation

◆ contrast

float Zivid::Point::contrast

Contrast.

◆ rgba

uint32_t Zivid::Point::rgba

Color (red,green,blue,alpha)

◆ x

float Zivid::Point::x

X coordinate.

◆ y

float Zivid::Point::y

Y coordinate.

◆ z

float Zivid::Point::z

Z coordinate.


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