EggRenderMode

from panda3d.egg import EggRenderMode
class EggRenderMode

Bases: DTOOL_SUPER_BASE

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 diagram

Inheritance diagram of EggRenderMode

AMBinary = 7
AMBlend = 3
AMBlendNoOcclude = 4
AMDual = 8
AMMs = 5
AMMsMask = 6
AMOff = 1
AMOn = 2
AMPremultiplied = 9
AMUnspecified = 0
AM_binary = 7
AM_blend = 3
AM_blend_no_occlude = 4
AM_dual = 8
AM_ms = 5
AM_ms_mask = 6
AM_off = 1
AM_on = 2
AM_premultiplied = 9
AM_unspecified = 0
DTMOff = 1
DTMOn = 2
DTMUnspecified = 0
DTM_off = 1
DTM_on = 2
DTM_unspecified = 0
DWMOff = 1
DWMOn = 2
DWMUnspecified = 0
DWM_off = 1
DWM_on = 2
DWM_unspecified = 0
VMHidden = 1
VMNormal = 2
VMUnspecified = 0
VM_hidden = 1
VM_normal = 2
VM_unspecified = 0
__init__(*args, **kwargs)
assign()

C++ Interface: assign(const EggRenderMode self, const EggRenderMode copy)

/**

*/

clearBin()

C++ Interface: clear_bin(const EggRenderMode self)

/**
  • Removes the bin name that was set for this particular object. See

  • set_bin().

*/

clearDepthOffset()

C++ Interface: clear_depth_offset(const EggRenderMode self)

/**
  • Removes the depth-offset flag from this particular object. See

  • set_depth_offset().

*/

clearDrawOrder()

C++ Interface: clear_draw_order(const EggRenderMode self)

/**
  • Removes the draw-order flag from this particular object. See

  • set_draw_order().

*/

clear_bin()

C++ Interface: clear_bin(const EggRenderMode self)

/**
  • Removes the bin name that was set for this particular object. See

  • set_bin().

*/

clear_depth_offset()

C++ Interface: clear_depth_offset(const EggRenderMode self)

/**
  • Removes the depth-offset flag from this particular object. See

  • set_depth_offset().

*/

clear_draw_order()

C++ Interface: clear_draw_order(const EggRenderMode self)

/**
  • Removes the draw-order flag from this particular object. See

  • set_draw_order().

*/

getAlphaMode()

C++ Interface: get_alpha_mode(EggRenderMode self)

/**
  • Returns the alpha mode that was set, or AM_unspecified if nothing was set.

  • See set_alpha_mode().

*/

getBin()

C++ Interface: get_bin(EggRenderMode self)

/**
  • Returns the bin name that has been set for this particular object, if any.

  • See set_bin().

*/

getClassType()

C++ Interface: get_class_type()

getDepthOffset()

C++ Interface: get_depth_offset(EggRenderMode self)

/**
  • Returns the “depth-offset” flag as set for this particular object. See

  • set_depth_offset().

*/

getDepthTestMode()

C++ Interface: get_depth_test_mode(EggRenderMode self)

/**
  • Returns the depth_test mode that was set, or DTM_unspecified if nothing was

  • set. See set_depth_test_mode().

*/

getDepthWriteMode()

C++ Interface: get_depth_write_mode(EggRenderMode self)

/**
  • Returns the depth_write mode that was set, or DWM_unspecified if nothing

  • was set. See set_depth_write_mode().

*/

getDrawOrder()

C++ Interface: get_draw_order(EggRenderMode self)

/**
  • Returns the “draw-order” flag as set for this particular object. See

  • set_draw_order().

*/

getVisibilityMode()

C++ Interface: get_visibility_mode(EggRenderMode self)

/**
  • Returns the visibility mode that was set, or VM_unspecified if nothing was

  • set. See set_visibility_mode().

*/

get_alpha_mode()

C++ Interface: get_alpha_mode(EggRenderMode self)

/**
  • Returns the alpha mode that was set, or AM_unspecified if nothing was set.

  • See set_alpha_mode().

*/

get_bin()

C++ Interface: get_bin(EggRenderMode self)

/**
  • Returns the bin name that has been set for this particular object, if any.

  • See set_bin().

*/

get_class_type()

C++ Interface: get_class_type()

get_depth_offset()

C++ Interface: get_depth_offset(EggRenderMode self)

/**
  • Returns the “depth-offset” flag as set for this particular object. See

  • set_depth_offset().

*/

get_depth_test_mode()

C++ Interface: get_depth_test_mode(EggRenderMode self)

/**
  • Returns the depth_test mode that was set, or DTM_unspecified if nothing was

  • set. See set_depth_test_mode().

*/

get_depth_write_mode()

C++ Interface: get_depth_write_mode(EggRenderMode self)

/**
  • Returns the depth_write mode that was set, or DWM_unspecified if nothing

  • was set. See set_depth_write_mode().

*/

get_draw_order()

C++ Interface: get_draw_order(EggRenderMode self)

/**
  • Returns the “draw-order” flag as set for this particular object. See

  • set_draw_order().

*/

get_visibility_mode()

C++ Interface: get_visibility_mode(EggRenderMode self)

/**
  • Returns the visibility mode that was set, or VM_unspecified if nothing was

  • set. See set_visibility_mode().

*/

hasBin()

C++ Interface: has_bin(EggRenderMode self)

/**
  • Returns true if a bin name has been set for this particular object. See

  • set_bin().

*/

hasDepthOffset()

C++ Interface: has_depth_offset(EggRenderMode self)

/**
  • Returns true if the depth-offset flag has been set for this particular

  • object. See set_depth_offset().

*/

hasDrawOrder()

C++ Interface: has_draw_order(EggRenderMode self)

/**
  • Returns true if the draw-order flag has been set for this particular

  • object. See set_draw_order().

*/

has_bin()

C++ Interface: has_bin(EggRenderMode self)

/**
  • Returns true if a bin name has been set for this particular object. See

  • set_bin().

*/

has_depth_offset()

C++ Interface: has_depth_offset(EggRenderMode self)

/**
  • Returns true if the depth-offset flag has been set for this particular

  • object. See set_depth_offset().

*/

has_draw_order()

C++ Interface: has_draw_order(EggRenderMode self)

/**
  • Returns true if the draw-order flag has been set for this particular

  • object. See set_draw_order().

*/

setAlphaMode()

C++ Interface: set_alpha_mode(const EggRenderMode self, int mode)

/**
  • 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()

C++ Interface: set_bin(const EggRenderMode self, str bin)

/**
  • 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().

*/

setDepthOffset()

C++ Interface: set_depth_offset(const EggRenderMode self, int bias)

/**
  • Sets the “depth-offset” flag associated with this object. This adds or

  • subtracts an offset bias into the depth buffer. See also DepthOffsetAttrib

  • and NodePath::set_depth_offset().

*/

setDepthTestMode()

C++ Interface: set_depth_test_mode(const EggRenderMode self, int mode)

/**
  • 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()

C++ Interface: set_depth_write_mode(const EggRenderMode self, int mode)

/**
  • Specifies whether writes should be made to the depth buffer (assuming the

  • rendering backend provides a depth buffer) when rendering this geometry.

*/

setDrawOrder()

C++ Interface: set_draw_order(const EggRenderMode self, int order)

/**
  • 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()

C++ Interface: set_visibility_mode(const EggRenderMode self, int mode)

/**
  • 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.

*/

set_alpha_mode()

C++ Interface: set_alpha_mode(const EggRenderMode self, int mode)

/**
  • 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.

*/

set_bin()

C++ Interface: set_bin(const EggRenderMode self, str bin)

/**
  • 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().

*/

set_depth_offset()

C++ Interface: set_depth_offset(const EggRenderMode self, int bias)

/**
  • Sets the “depth-offset” flag associated with this object. This adds or

  • subtracts an offset bias into the depth buffer. See also DepthOffsetAttrib

  • and NodePath::set_depth_offset().

*/

set_depth_test_mode()

C++ Interface: set_depth_test_mode(const EggRenderMode self, int mode)

/**
  • 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.

*/

set_depth_write_mode()

C++ Interface: set_depth_write_mode(const EggRenderMode self, int mode)

/**
  • Specifies whether writes should be made to the depth buffer (assuming the

  • rendering backend provides a depth buffer) when rendering this geometry.

*/

set_draw_order()

C++ Interface: set_draw_order(const EggRenderMode self, int order)

/**
  • 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().

*/

set_visibility_mode()

C++ Interface: set_visibility_mode(const EggRenderMode self, int mode)

/**
  • 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()

C++ Interface: string_alpha_mode(str string)

/**
  • Returns the AlphaMode value associated with the given string

  • representation, or AM_unspecified if the string does not match any known

  • AlphaMode value.

*/

stringDepthTestMode()

C++ Interface: string_depth_test_mode(str string)

/**
  • Returns the DepthTestMode value associated with the given string

  • representation, or DTM_unspecified if the string does not match any known

  • DepthTestMode value.

*/

stringDepthWriteMode()

C++ Interface: string_depth_write_mode(str string)

/**
  • Returns the DepthWriteMode value associated with the given string

  • representation, or DWM_unspecified if the string does not match any known

  • DepthWriteMode value.

*/

stringVisibilityMode()

C++ Interface: string_visibility_mode(str string)

/**
  • Returns the HiddenMode value associated with the given string

  • representation, or VM_unspecified if the string does not match any known

  • HiddenMode value.

*/

string_alpha_mode()

C++ Interface: string_alpha_mode(str string)

/**
  • Returns the AlphaMode value associated with the given string

  • representation, or AM_unspecified if the string does not match any known

  • AlphaMode value.

*/

string_depth_test_mode()

C++ Interface: string_depth_test_mode(str string)

/**
  • Returns the DepthTestMode value associated with the given string

  • representation, or DTM_unspecified if the string does not match any known

  • DepthTestMode value.

*/

string_depth_write_mode()

C++ Interface: string_depth_write_mode(str string)

/**
  • Returns the DepthWriteMode value associated with the given string

  • representation, or DWM_unspecified if the string does not match any known

  • DepthWriteMode value.

*/

string_visibility_mode()

C++ Interface: string_visibility_mode(str string)

/**
  • Returns the HiddenMode value associated with the given string

  • representation, or VM_unspecified if the string does not match any known

  • HiddenMode value.

*/

write()

C++ Interface: write(EggRenderMode self, ostream out, int indent_level)

/**
  • Writes the attributes to the indicated output stream in Egg format.

*/