CullBinManager

from panda3d.core import CullBinManager
class CullBinManager

Bases: CullBinEnums

This is a global object that maintains the collection of named CullBins in the world.

Inheritance diagram

Inheritance diagram of CullBinManager

__init__(*args, **kwargs)
addBin()

C++ Interface: add_bin(const CullBinManager self, str name, int type, int sort)

/**
  • Defines a new bin with the indicated name, and returns the new bin_index.

  • If there is already a bin with the same name returns its bin_index if it

  • had the same properties; otherwise, reports an error and returns -1.

*/

add_bin()

C++ Interface: add_bin(const CullBinManager self, str name, int type, int sort)

/**
  • Defines a new bin with the indicated name, and returns the new bin_index.

  • If there is already a bin with the same name returns its bin_index if it

  • had the same properties; otherwise, reports an error and returns -1.

*/

findBin()

C++ Interface: find_bin(CullBinManager self, str name)

/**
  • Returns the bin_index associated with the bin of the given name, or -1 if

  • no bin has that name.

*/

find_bin()

C++ Interface: find_bin(CullBinManager self, str name)

/**
  • Returns the bin_index associated with the bin of the given name, or -1 if

  • no bin has that name.

*/

getBin()

C++ Interface: get_bin(CullBinManager self, int n)

/**
  • Returns the bin_index of the nth bin in the set, where n is a number

  • between 0 and get_num_bins(). This returns the list of bin_index numbers,

  • in sorted order (that is, in the order in which the bins should be

  • rendered).

*/

getBinActive()

C++ Interface: get_bin_active(CullBinManager self, str name) get_bin_active(CullBinManager self, int bin_index)

/**
  • Returns the active flag of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

/**
  • Returns the active flag of the bin with the indicated name.

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

getBinFlashActive()

C++ Interface: get_bin_flash_active(CullBinManager self, int bin_index)

/**
  • Returns true if the bin with the given bin_index is configured to flash at

  • a predetermined color (where bin_index was retrieved by get_bin() or

  • find_bin()).

  • This method is not available in release builds.

*/

getBinFlashColor()

C++ Interface: get_bin_flash_color(CullBinManager self, int bin_index)

/**
  • Returns the color that this bin has been configured to flash to, if

  • configured.

  • This method is not available in release builds.

*/

getBinName()

C++ Interface: get_bin_name(CullBinManager self, int bin_index)

/**
  • Returns the name of the bin with the indicated bin_index (where bin_index

  • was retrieved by get_bin() or find_bin()). The bin’s name may not be

  • changed during the life of the bin.

*/

getBinSort()

C++ Interface: get_bin_sort(CullBinManager self, str name) get_bin_sort(CullBinManager self, int bin_index)

/**
  • Returns the sort order of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

/**
  • Returns the sort order of the bin with the indicated name.

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

getBinType()

C++ Interface: get_bin_type(CullBinManager self, str name) get_bin_type(CullBinManager self, int bin_index)

/**
  • Returns the type of the bin with the indicated bin_index (where bin_index

  • was retrieved by get_bin() or find_bin()).

*/

/**
  • Returns the type of the bin with the indicated name.

*/

getBins()
getGlobalPtr()

C++ Interface: get_global_ptr()

/**
  • Returns the pointer to the global CullBinManager object.

*/

getNumBins()

C++ Interface: get_num_bins(CullBinManager self)

/**
  • Returns the number of bins in the world.

*/

get_bin()

C++ Interface: get_bin(CullBinManager self, int n)

/**
  • Returns the bin_index of the nth bin in the set, where n is a number

  • between 0 and get_num_bins(). This returns the list of bin_index numbers,

  • in sorted order (that is, in the order in which the bins should be

  • rendered).

*/

get_bin_active()

C++ Interface: get_bin_active(CullBinManager self, str name) get_bin_active(CullBinManager self, int bin_index)

/**
  • Returns the active flag of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

/**
  • Returns the active flag of the bin with the indicated name.

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

get_bin_flash_active()

C++ Interface: get_bin_flash_active(CullBinManager self, int bin_index)

/**
  • Returns true if the bin with the given bin_index is configured to flash at

  • a predetermined color (where bin_index was retrieved by get_bin() or

  • find_bin()).

  • This method is not available in release builds.

*/

get_bin_flash_color()

C++ Interface: get_bin_flash_color(CullBinManager self, int bin_index)

/**
  • Returns the color that this bin has been configured to flash to, if

  • configured.

  • This method is not available in release builds.

*/

get_bin_name()

C++ Interface: get_bin_name(CullBinManager self, int bin_index)

/**
  • Returns the name of the bin with the indicated bin_index (where bin_index

  • was retrieved by get_bin() or find_bin()). The bin’s name may not be

  • changed during the life of the bin.

*/

get_bin_sort()

C++ Interface: get_bin_sort(CullBinManager self, str name) get_bin_sort(CullBinManager self, int bin_index)

/**
  • Returns the sort order of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

/**
  • Returns the sort order of the bin with the indicated name.

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

get_bin_type()

C++ Interface: get_bin_type(CullBinManager self, str name) get_bin_type(CullBinManager self, int bin_index)

/**
  • Returns the type of the bin with the indicated bin_index (where bin_index

  • was retrieved by get_bin() or find_bin()).

*/

/**
  • Returns the type of the bin with the indicated name.

*/

get_bins()
get_global_ptr()

C++ Interface: get_global_ptr()

/**
  • Returns the pointer to the global CullBinManager object.

*/

get_num_bins()

C++ Interface: get_num_bins(CullBinManager self)

/**
  • Returns the number of bins in the world.

*/

removeBin()

C++ Interface: remove_bin(const CullBinManager self, int bin_index)

/**
  • Permanently removes the indicated bin. This operation is not protected

  • from the pipeline and will disturb whatever is currently rendering in draw.

  • You should not call this during the normal course of rendering a frame; it

  • is intended only as an aid to development, to allow the developer to

  • interactively fiddle with the set of bins.

*/

remove_bin()

C++ Interface: remove_bin(const CullBinManager self, int bin_index)

/**
  • Permanently removes the indicated bin. This operation is not protected

  • from the pipeline and will disturb whatever is currently rendering in draw.

  • You should not call this during the normal course of rendering a frame; it

  • is intended only as an aid to development, to allow the developer to

  • interactively fiddle with the set of bins.

*/

setBinActive()

C++ Interface: set_bin_active(const CullBinManager self, str name, bool active) set_bin_active(const CullBinManager self, int bin_index, bool active)

/**
  • Changes the active flag of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

/**
  • Changes the active flag of the bin with the indicated name.

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

setBinFlashActive()

C++ Interface: set_bin_flash_active(const CullBinManager self, int bin_index, bool active)

/**
  • When set to true, the given bin_index is configured to flash at a

  • predetermined color (where bin_index was retrieved by get_bin() or

  • find_bin()).

  • This method is not available in release builds.

*/

setBinFlashColor()

C++ Interface: set_bin_flash_color(const CullBinManager self, int bin_index, const LVecBase4f color)

/**
  • Changes the flash color for the given bin index.

  • This method is not available in release builds.

*/

setBinSort()

C++ Interface: set_bin_sort(const CullBinManager self, str name, int sort) set_bin_sort(const CullBinManager self, int bin_index, int sort)

/**
  • Changes the sort order of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

/**
  • Changes the sort order of the bin with the indicated name.

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

setBinType()

C++ Interface: set_bin_type(const CullBinManager self, str name, int type) set_bin_type(const CullBinManager self, int bin_index, int type)

/**
  • Changes the type of the bin with the indicated bin_index (where bin_index

  • was retrieved by get_bin() or find_bin()).

  • The change might be effective immediately, or it might take place next

  • frame, depending on the bin type.

*/

/**
  • Changes the type of the bin with the indicated name.

  • The change might be effective immediately, or it might take place next

  • frame, depending on the bin type.

*/

set_bin_active()

C++ Interface: set_bin_active(const CullBinManager self, str name, bool active) set_bin_active(const CullBinManager self, int bin_index, bool active)

/**
  • Changes the active flag of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

/**
  • Changes the active flag of the bin with the indicated name.

  • When a bin is marked inactive, all geometry assigned to it is not rendered.

*/

set_bin_flash_active()

C++ Interface: set_bin_flash_active(const CullBinManager self, int bin_index, bool active)

/**
  • When set to true, the given bin_index is configured to flash at a

  • predetermined color (where bin_index was retrieved by get_bin() or

  • find_bin()).

  • This method is not available in release builds.

*/

set_bin_flash_color()

C++ Interface: set_bin_flash_color(const CullBinManager self, int bin_index, const LVecBase4f color)

/**
  • Changes the flash color for the given bin index.

  • This method is not available in release builds.

*/

set_bin_sort()

C++ Interface: set_bin_sort(const CullBinManager self, str name, int sort) set_bin_sort(const CullBinManager self, int bin_index, int sort)

/**
  • Changes the sort order of the bin with the indicated bin_index (where

  • bin_index was retrieved by get_bin() or find_bin()).

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

/**
  • Changes the sort order of the bin with the indicated name.

  • The bins are rendered in increasing order by their sort order; this number

  • may be changed from time to time to reorder the bins.

*/

set_bin_type()

C++ Interface: set_bin_type(const CullBinManager self, str name, int type) set_bin_type(const CullBinManager self, int bin_index, int type)

/**
  • Changes the type of the bin with the indicated bin_index (where bin_index

  • was retrieved by get_bin() or find_bin()).

  • The change might be effective immediately, or it might take place next

  • frame, depending on the bin type.

*/

/**
  • Changes the type of the bin with the indicated name.

  • The change might be effective immediately, or it might take place next

  • frame, depending on the bin type.

*/

write()

C++ Interface: write(CullBinManager self, ostream out)

/**

*/