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 33 of file sg_base.cpp.

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

    return;
}

References blue, green, and red.

SGCOLOR() [2/2]

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

Definition at line 42 of file sg_base.cpp.

{
    if( !checkRange( aRVal, aGVal, aBVal ) )
    {
#ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] invalid value passed to constructor";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
        red = 0.0;
        green = 0.0;
        blue = 0.0;
        return;
    }

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

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

Member Function Documentation

checkRange()

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

privatenoexcept

Definition at line 147 of file sg_base.cpp.

{
    bool ok = true;

    if( aRedVal < 0.0 || aRedVal > 1.0 )
    {
#ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] invalid RED value: " << aRedVal;
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
#endif
        ok = false;
    }

    if( aGreenVal < 0.0 || aGreenVal > 1.0 )
    {
#ifdef DEBUG
        if( ok )
        {
            wxLogTrace( MASK_3D_SG, "%s:%s:%d\n", __FILE__, __FUNCTION__, __LINE__ );
        }
        wxLogTrace( MASK_3D_SG, " * [BUG] invalid GREEN value: %f\n", aGreenVal );
#endif
        ok = false;
    }

    if( aBlueVal < 0.0 || aBlueVal > 1.0 )
    {
#ifdef DEBUG
        if( ok )
        {
            wxLogTrace( MASK_3D_SG, "%s:%s:%d\n", __FILE__, __FUNCTION__, __LINE__ );
        }
        wxLogTrace( MASK_3D_SG, " * [BUG] invalid BLUE value: %f\n", aBlueVal );
#endif
        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 65 of file sg_base.cpp.

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

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 74 of file sg_base.cpp.

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

GetColor() [3/3]

void SGCOLOR::GetColor ( SGCOLOR *  aColor ) const

noexcept

Definition at line 83 of file sg_base.cpp.

{
    if( NULL == aColor )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] NULL pointer passed for aColor";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return;
    }

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

References NULL.

SetColor() [1/3]

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

Definition at line 104 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 117 of file sg_base.cpp.

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

SetColor() [3/3]

bool SGCOLOR::SetColor ( const SGCOLOR *  aColor )

noexcept

Definition at line 126 of file sg_base.cpp.

{
    if( NULL == aColor )
    {
        #ifdef DEBUG
        std::ostringstream ostr;
        ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
        ostr << " * [BUG] NULL pointer passed for aColor";
        wxLogTrace( MASK_3D_SG, "%s\n", ostr.str().c_str() );
        #endif

        return false;
    }

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

References NULL.

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