cee::ug::MirrorSettings Class Reference

Settings for mirrors in the model. More...

Public Member Functions

bool isMirrorEnabled () const
 Returns true if mirroring is enabled. More...
 
void enableMirroring (bool enable)
 Toggles mirroring enabled/disabled for the model. More...
 
bool isReflective () const
 Gets reflective mirroring flag. More...
 
void setReflective (bool reflective)
 Sets reflective mirroring flag. More...
 
unsigned int numberOfMirrorPasses () const
 Returns number of mirror passes. More...
 
void setNumberOfMirrorPasses (unsigned int numPasses)
 Sets the number of mirror passes. More...
 
unsigned int maximumNumberOfMirrorPasses () const
 Returns the maximum number of allowed mirror passes. More...
 
Plane firstPlane () const
 Returns the first mirror plane. More...
 
Plane secondPlane () const
 Returns the second mirror plane. More...
 
Plane masterPlane () const
 Returns the master mirror plane. More...
 
void setFirstPlane (Plane plane)
 Sets the first mirror plane. More...
 
void setSecondPlane (Plane plane)
 Sets the second mirror plane. More...
 
void setMasterPlane (Plane plane)
 Sets the master mirror plane. More...
 

Detailed Description

Settings for mirrors in the model.

The Ceetron Desktop Components offers mirror support with three symmetry planes.

Mirror settings are applied per model. Access mirror settings from UnstructGridModel::mirrorSettings().

Member Function Documentation

void cee::ug::MirrorSettings::enableMirroring ( bool  enable)

Toggles mirroring enabled/disabled for the model.

Plane cee::ug::MirrorSettings::firstPlane ( ) const

Returns the first mirror plane.

See also
Plane
bool cee::ug::MirrorSettings::isMirrorEnabled ( ) const

Returns true if mirroring is enabled.

bool cee::ug::MirrorSettings::isReflective ( ) const

Gets reflective mirroring flag.

Plane cee::ug::MirrorSettings::masterPlane ( ) const

Returns the master mirror plane.

See also
Plane
unsigned int cee::ug::MirrorSettings::maximumNumberOfMirrorPasses ( ) const

Returns the maximum number of allowed mirror passes.

unsigned int cee::ug::MirrorSettings::numberOfMirrorPasses ( ) const

Returns number of mirror passes.

Plane cee::ug::MirrorSettings::secondPlane ( ) const

Returns the second mirror plane.

See also
Plane
void cee::ug::MirrorSettings::setFirstPlane ( Plane  plane)

Sets the first mirror plane.

See also
Plane
void cee::ug::MirrorSettings::setMasterPlane ( Plane  plane)

Sets the master mirror plane.

See also
Plane
void cee::ug::MirrorSettings::setNumberOfMirrorPasses ( unsigned int  numPasses)

Sets the number of mirror passes.

void cee::ug::MirrorSettings::setReflective ( bool  reflective)

Sets reflective mirroring flag.

void cee::ug::MirrorSettings::setSecondPlane ( Plane  plane)

Sets the second mirror plane.

See also
Plane