SGCOLOR Class Reference

#include <sg_base.h>

Public Member Functions
	SGCOLOR ()
	SGCOLOR (float aRVal, float aGVal, float aBVal)
void	GetColor (float &aRedVal, float &aGreenVal, float &aBlueVal) const noexcept
void	GetColor (SGCOLOR &aColor) const noexcept
void	GetColor (SGCOLOR *aColor) const noexcept
bool	SetColor (float aRedVal, float aGreenVal, float aBlueVal)
bool	SetColor (const SGCOLOR &aColor) noexcept
bool	SetColor (const SGCOLOR *aColor) noexcept

Protected Attributes
float	red
float	green
float	blue

Private Member Functions
bool	checkRange (float aRedVal, float aGreenVal, float aBlueVal) const noexcept

Detailed Description

Definition at line 43 of file sg_base.h.

Constructor & Destructor Documentation

SGCOLOR() [1/2]

SGCOLOR::SGCOLOR

(

)

Definition at line 34 of file sg_base.cpp.

{
 red = 0.0;
 green = 0.0;
 blue = 0.0;
}

References blue, green, and red.

SGCOLOR() [2/2]

SGCOLOR::SGCOLOR	(	float	aRVal,
		float	aGVal,
		float	aBVal
	)

Definition at line 41 of file sg_base.cpp.

{
 if( !checkRange( aRVal, aGVal, aBVal ) )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] invalid value passed to constructor" ),
 __FILE__, __FUNCTION__, __LINE__ );
 red = 0.0;
 green = 0.0;
 blue = 0.0;
 return;
 }

 red = aRVal;
 green = aGVal;
 blue = aBVal;
}

References blue, checkRange(), green, and red.

Member Function Documentation

checkRange()

bool SGCOLOR::checkRange ( float  aRedVal, float  aGreenVal, float  aBlueVal  ) const

privatenoexcept

Definition at line 118 of file sg_base.cpp.

{
 bool ok = true;

 if( aRedVal < 0.0 || aRedVal > 1.0 )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] invalid RED value: %g" ),
 __FILE__, __FUNCTION__, __LINE__, aRedVal );

 ok = false;
 }

 if( aGreenVal < 0.0 || aGreenVal > 1.0 )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] invalid GREEN value: %g" ),
 __FILE__, __FUNCTION__, __LINE__, aGreenVal );

 ok = false;
 }

 if( aBlueVal < 0.0 || aBlueVal > 1.0 )
 {
 wxLogTrace( MASK_3D_SG, wxT( "%s:%s:%d * [BUG] invalid BLUE value: %g" ),
 __FILE__, __FUNCTION__, __LINE__, aBlueVal );

 ok = false;
 }

 return ok;
}

Referenced by SetColor(), and SGCOLOR().

GetColor() [1/3]

void SGCOLOR::GetColor ( float &  aRedVal, float &  aGreenVal, float &  aBlueVal  ) const

noexcept

Definition at line 59 of file sg_base.cpp.

{
 aRedVal = red;
 aGreenVal = green;
 aBlueVal = blue;
}

References red.

Referenced by S3D::FormatColor(), formatMaterial(), SGSHAPE::Prepare(), S3D::WriteColor(), and SGAPPEARANCE::WriteVRML().

GetColor() [2/3]

void SGCOLOR::GetColor ( SGCOLOR &  aColor ) const

noexcept

Definition at line 67 of file sg_base.cpp.

{
 aColor.red = red;
 aColor.green = green;
 aColor.blue = blue;
}

References red.

GetColor() [3/3]

void SGCOLOR::GetColor ( SGCOLOR *  aColor ) const

noexcept

Definition at line 75 of file sg_base.cpp.

{
 wxCHECK_MSG( aColor, /* void */, wxT( "NULL pointer passed for aRGBColor" ) );

 aColor->red = red;
 aColor->green = green;
 aColor->blue = blue;
}

References red.

SetColor() [1/3]

bool SGCOLOR::SetColor	(	float	aRedVal,
		float	aGreenVal,
		float	aBlueVal
	)

Definition at line 85 of file sg_base.cpp.

{
 if( !checkRange( aRedVal, aGreenVal, aBlueVal ) )
 return false;

 red = aRedVal;
 green = aGreenVal;
 blue = aBlueVal;

 return true;
}

References blue, checkRange(), green, and red.

Referenced by WRL1MATERIAL::GetColor(), S3D::ReadColor(), SGAPPEARANCE::SetAmbient(), SGAPPEARANCE::SetDiffuse(), SGAPPEARANCE::SetEmissive(), SGAPPEARANCE::SetSpecular(), SGAPPEARANCE::SGAPPEARANCE(), and WRL2FACESET::TranslateToSG().

SetColor() [2/3]

bool SGCOLOR::SetColor ( const SGCOLOR &  aColor )

noexcept

Definition at line 98 of file sg_base.cpp.

{
 red = aColor.red;
 green = aColor.green;
 blue = aColor.blue;
 return true;
}

References red.

SetColor() [3/3]

bool SGCOLOR::SetColor ( const SGCOLOR *  aColor )

noexcept

Definition at line 107 of file sg_base.cpp.

{
 wxCHECK_MSG( aColor, false, wxT( "NULL pointer passed for aRGBColor" ) );

 red = aColor->red;
 green = aColor->green;
 blue = aColor->blue;
 return true;
}

References red.

Member Data Documentation

blue

float SGCOLOR::blue

protected

Definition at line 48 of file sg_base.h.

Referenced by SetColor(), and SGCOLOR().

green

float SGCOLOR::green

protected

Definition at line 47 of file sg_base.h.

Referenced by SetColor(), and SGCOLOR().

red

float SGCOLOR::red

protected

Definition at line 46 of file sg_base.h.

Referenced by SetColor(), and SGCOLOR().

---

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

• sg_base.h
• sg_base.cpp