SPIKE-RT C++ API Reference
Loading...
Searching...
No Matches
spikeapi::ColorSensor Class Reference

#include <ColorSensor.h>

Classes

struct  HSV
struct  RGB

Public Member Functions

 ColorSensor (EPort port)
void getRGB (RGB &rgb) const
void getColor (HSV &hsv, bool surface=true) const
void getHSV (HSV &hsv, bool surface=true) const
int32_t getReflection () const
int32_t getAmbient () const
void setLight (int32_t bv1, int32_t bv2, int32_t bv3) const
void lightOn () const
void lightOff () const
void setDetectableColors (int32_t size, pup_color_hsv_t *colors) const
bool hasError ()

Detailed Description

SPIKE カラーセンサクラス

Constructor & Destructor Documentation

◆ ColorSensor()

spikeapi::ColorSensor::ColorSensor ( EPort port)
inline

コンストラクタ

Parameters
portPUPポートID

Member Function Documentation

◆ getAmbient()

int32_t spikeapi::ColorSensor::getAmbient ( ) const
inline

周囲の光の強度を測定する

Returns
周囲の光の強度(%)

◆ getColor()

void spikeapi::ColorSensor::getColor ( HSV & hsv,
bool surface = true ) const
inline

カラーセンサで色を測定する

Parameters
surfacetrueならば表面の色から、falseならば他の光源の色を検出する
Returns
色(hsvによる表現)

◆ getHSV()

void spikeapi::ColorSensor::getHSV ( HSV & hsv,
bool surface = true ) const
inline

カラーセンサで色を測定する(近似なし)

Parameters
surfacetrueならば表面の色から、falseならば他の光源の色を検出する
Returns
色(hsvによる表現)

◆ getReflection()

int32_t spikeapi::ColorSensor::getReflection ( ) const
inline

センサーの発する光を表面がどの程度反射するかを測定する

Returns
どの程度反射しているか(%)

◆ getRGB()

void spikeapi::ColorSensor::getRGB ( RGB & rgb) const
inline

カラーセンサのRGB値を取得する

Parameters
値を設定するRGB構造体、各色8ビット
Returns
-

◆ hasError()

bool spikeapi::ColorSensor::hasError ( )
inline

インスタンス生成が正常にできたかどうかを確認するための共通メソッド mDeviceがNULLの場合にtrueとなる

◆ lightOff()

void spikeapi::ColorSensor::lightOff ( ) const
inline

カラーセンサのライトを消灯する

Parameters
-
Returns
-

◆ lightOn()

void spikeapi::ColorSensor::lightOn ( ) const
inline

カラーセンサのライトを点灯する

Parameters
-
Returns
-

◆ setDetectableColors()

void spikeapi::ColorSensor::setDetectableColors ( int32_t size,
pup_color_hsv_t * colors ) const
inline

カラーセンサが検知する色を設定する

Parameters
sizeカラーの配列のサイズ
colorsカラーの配列
Returns
-

◆ setLight()

void spikeapi::ColorSensor::setLight ( int32_t bv1,
int32_t bv2,
int32_t bv3 ) const
inline

カラーセンサのライトを設定する

Parameters
bv1輝度1
bv2輝度2
bv3輝度3
Returns
-

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