# EggRenderMode

from pandac.PandaModules import EggRenderMode

Class : EggRenderMode
Description : This class stores miscellaneous rendering properties that is associated with geometry, and which may be set on the geometry primitive level, on the group above it, or indirectly via a texture. It's intended to be a base class for egg objects that can have these properties set.
This class cannot inherit from EggObject, because it causes problems at the EggPolygon level with multiple appearances of the EggObject base class. And making EggObject a virtual base class is just no fun.

## Inheritance:

EggRenderMode:

## Methods of EggRenderMode:

EggRenderMode (Constructor)
clearBin
clearDrawOrder
getAlphaMode
getBin
getClassType
getDepthTestMode
getDepthWriteMode
getDrawOrder
getVisibilityMode
hasBin
hasDrawOrder
operator !=
operator <
operator =
operator ==
setAlphaMode
setBin
setDepthTestMode
setDepthWriteMode
setDrawOrder
setVisibilityMode
stringAlphaMode
stringDepthTestMode
stringDepthWriteMode
stringVisibilityMode
write

## Constants in EggRenderMode:

AMUnspecified | (AlphaMode)
AMOff | (AlphaMode)
AMOn | (AlphaMode)
AMBlend | (AlphaMode)
AMBlendNoOcclude | (AlphaMode)
AMMs | (AlphaMode)
AMMsMask | (AlphaMode)
AMBinary | (AlphaMode)
AMDual | (AlphaMode)
DWMUnspecified | (DepthWriteMode)
DWMOff | (DepthWriteMode)
DWMOn | (DepthWriteMode)
DTMUnspecified | (DepthTestMode)
DTMOff | (DepthTestMode)
DTMOn | (DepthTestMode)
VMUnspecified | (VisibilityMode)
VMHidden | (VisibilityMode)
VMNormal | (VisibilityMode)

EggRenderMode EggRenderMode::EggRenderMode(void); Description:

clearBin void EggRenderMode::clear_bin(void); Description: Removes the bin name that was set for this particular object. See set_bin().

clearDrawOrder void EggRenderMode::clear_draw_order(void); Description: Removes the draw-order flag from this particular object. See set_draw_order().

getAlphaMode EggRenderMode::AlphaMode EggRenderMode::get_alpha_mode(void) const; Description: Returns the alpha mode that was set, or AM_unspecified if nothing was set. See set_alpha_mode().

getBin string EggRenderMode::get_bin(void) const; Description: Returns the bin name that has been set for this particular object, if any. See set_bin().

getClassType static TypeHandle EggRenderMode::get_class_type(void); Undocumented function.

getDepthTestMode EggRenderMode::DepthTestMode EggRenderMode::get_depth_test_mode(void) const; Description: Returns the depth_test mode that was set, or DTM_unspecified if nothing was set. See set_depth_test_mode().

getDepthWriteMode EggRenderMode::DepthWriteMode EggRenderMode::get_depth_write_mode(void) const; Description: Returns the depth_write mode that was set, or DWM_unspecified if nothing was set. See set_depth_write_mode().

getDrawOrder int EggRenderMode::get_draw_order(void) const; Description: Returns the "draw-order" flag as set for this particular object. See set_draw_order().

getVisibilityMode EggRenderMode::VisibilityMode EggRenderMode::get_visibility_mode(void) const; Description: Returns the visibility mode that was set, or VM_unspecified if nothing was set. See set_visibility_mode().

hasBin bool EggRenderMode::has_bin(void) const; Description: Returns true if a bin name has been set for this particular object. See set_bin().

hasDrawOrder bool EggRenderMode::has_draw_order(void) const; Description: Returns true if the draw-order flag has been set for this particular object. See set_draw_order().

operator != bool EggRenderMode::operator !=(EggRenderMode const &other) const; Comparison operators are handy. Description:

operator < bool EggRenderMode::operator <(EggRenderMode const &other) const; Description:

operator = EggRenderMode &EggRenderMode::operator =(EggRenderMode const &copy); Description:

operator == bool EggRenderMode::operator ==(EggRenderMode const &other) const; Comparison operators are handy. Description:

setAlphaMode void EggRenderMode::set_alpha_mode(EggRenderMode::AlphaMode mode); Description: Specifies precisely how the transparency for this geometry should be achieved, or if it should be used. The default, AM_unspecified, is to use transparency if the geometry has a color whose alpha value is non-1, or if it has a four-channel texture applied; otherwise, AM_on forces transparency on, and AM_off forces it off. The other flavors of transparency are specific ways to turn on transparency, which may or may not be supported by a particular rendering backend.

setBin void EggRenderMode::set_bin(string const &bin); Description: Sets the "bin" string for this particular object. This names a particular bin in which the object should be rendered. The exact meaning of a bin is implementation defined, but generally a GeomBin matching each bin name must also be specifically added to the rendering engine (e.g. the CullTraverser) in use for this to work. See also set_draw_order().

setDepthTestMode void EggRenderMode::set_depth_test_mode(EggRenderMode::DepthTestMode mode); Description: Specifies whether this geometry should be tested against the depth buffer when it is drawn (assuming the rendering backend provides a depth buffer). Note that this is different, and independent from, the depth_write mode.

setDepthWriteMode void EggRenderMode::set_depth_write_mode(EggRenderMode::DepthWriteMode mode); Description: Specifies whether writes should be made to the depth buffer (assuming the rendering backend provides a depth buffer) when rendering this geometry.

setDrawOrder void EggRenderMode::set_draw_order(int order); Description: Sets the "draw-order" flag associated with this object. This specifies a particular order in which objects of this type should be drawn, within the specified bin. If a bin is not explicitly specified, "fixed" is used. See also set_bin().

setVisibilityMode void EggRenderMode::set_visibility_mode(EggRenderMode::VisibilityMode mode); Description: Specifies whether this geometry is to be considered normally visible, or hidden. If it is hidden, it is either not loaded into the scene graph at all, or loaded as a "stashed" node, according to the setting of egg-suppress-hidden.

stringAlphaMode static EggRenderMode::AlphaMode EggRenderMode::string_alpha_mode(string const &string); Description: Returns the AlphaMode value associated with the given string representation, or AM_unspecified if the string does not match any known AlphaMode value.

stringDepthTestMode static EggRenderMode::DepthTestMode EggRenderMode::string_depth_test_mode(string const &string); Description: Returns the DepthTestMode value associated with the given string representation, or DTM_unspecified if the string does not match any known DepthTestMode value.

stringDepthWriteMode static EggRenderMode::DepthWriteMode EggRenderMode::string_depth_write_mode(string const &string); Description: Returns the DepthWriteMode value associated with the given string representation, or DWM_unspecified if the string does not match any known DepthWriteMode value.

stringVisibilityMode static EggRenderMode::VisibilityMode EggRenderMode::string_visibility_mode(string const &string); Description: Returns the HiddenMode value associated with the given string representation, or VM_unspecified if the string does not match any known HiddenMode value.

write void EggRenderMode::write(ostream &out, int indent_level) const; Description: Writes the attributes to the indicated output stream in Egg format.