Panda3D
Public Member Functions | Static Public Member Functions | Protected Member Functions

ColorInterpolationManager Class Reference

High level class for color interpolation. More...

#include "colorInterpolationManager.h"

Inheritance diagram for ColorInterpolationManager:
ReferenceCount MemoryBase

List of all members.

Public Member Functions

 ColorInterpolationManager ()
 default constructor
 ColorInterpolationManager (const Colorf &c)
 constructor
 ColorInterpolationManager (const ColorInterpolationManager &copy)
 copy constructor
virtual ~ColorInterpolationManager ()
 destructor
int add_constant (const float time_begin=0.0f, const float time_end=1.0f, const Colorf color=Colorf(1.0f, 1.0f, 1.0f, 1.0f), const bool is_modulated=true)
 Adds a constant segment of the specified color to the manager and returns the segment's id as known by the manager.
int add_linear (const float time_begin=0.0f, const float time_end=1.0f, const Colorf color_a=Colorf(1.0f, 0.0f, 0.0f, 1.0f), const Colorf color_b=Colorf(0.0f, 1.0f, 0.0f, 1.0f), const bool is_modulated=true)
 Adds a linear segment between two colors to the manager and returns the segment's id as known by the manager.
int add_sinusoid (const float time_begin=0.0f, const float time_end=1.0f, const Colorf color_a=Colorf(1.0f, 0.0f, 0.0f, 1.0f), const Colorf color_b=Colorf(0.0f, 1.0f, 0.0f, 1.0f), const float period=1.0f, const bool is_modulated=true)
 Adds a stepwave segment of two colors and a specified period to the manager and returns the segment's id as known by the manager.
int add_stepwave (const float time_begin=0.0f, const float time_end=1.0f, const Colorf color_a=Colorf(1.0f, 0.0f, 0.0f, 1.0f), const Colorf color_b=Colorf(0.0f, 1.0f, 0.0f, 1.0f), const float width_a=0.5f, const float width_b=0.5f, const bool is_modulated=true)
 Adds a stepwave segment of two colors to the manager and returns the segment's id as known by the manager.
void clear_segment (const int seg_id)
 Removes the segment of 'id' from the manager.
void clear_to_initial ()
 Removes all segments from the manager.
Colorf generateColor (const float interpolated_time)
 For time 'interpolated_time', this returns the additive composite color of all segments that influence that instant in the particle's lifetime.
int get_ref_count () const
 Returns the current reference count.
ColorInterpolationSegmentget_segment (const int seg_id)
 Returns the segment that corresponds to 'seg_id'.
string get_segment_id_list ()
 Returns a space delimited list of all of the ids in the manager at the time.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new[] (size_t size)
void * operator new[] (size_t size, void *ptr)
void ref () const
 Explicitly increments the reference count.
void set_default_color (const Colorf &c)
 Sets the color to used if no segments are present.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()

Protected Member Functions

bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.

Detailed Description

High level class for color interpolation.

Segments must be added to the manager in order to achieve results using the "add_*****()" functions. Access to these segments is provided but not necessary general use.

Definition at line 283 of file colorInterpolationManager.h.


Constructor & Destructor Documentation

ColorInterpolationManager::ColorInterpolationManager ( )

default constructor

Definition at line 261 of file colorInterpolationManager.cxx.

ColorInterpolationManager::ColorInterpolationManager ( const Colorf c)

constructor

Definition at line 273 of file colorInterpolationManager.cxx.

ColorInterpolationManager::ColorInterpolationManager ( const ColorInterpolationManager copy)

copy constructor

Definition at line 285 of file colorInterpolationManager.cxx.

ColorInterpolationManager::~ColorInterpolationManager ( ) [virtual]

destructor

Definition at line 298 of file colorInterpolationManager.cxx.


Member Function Documentation

int ColorInterpolationManager::add_constant ( const float  time_begin = 0.0f,
const float  time_end = 1.0f,
const Colorf  color = Colorf(1.0f,1.0f,1.0f,1.0f),
const bool  is_modulated = true 
)

Adds a constant segment of the specified color to the manager and returns the segment's id as known by the manager.

Definition at line 310 of file colorInterpolationManager.cxx.

int ColorInterpolationManager::add_linear ( const float  time_begin = 0.0f,
const float  time_end = 1.0f,
const Colorf  color_a = Colorf(1.0f,0.0f,0.0f,1.0f),
const Colorf  color_b = Colorf(0.0f,1.0f,0.0f,1.0f),
const bool  is_modulated = true 
)

Adds a linear segment between two colors to the manager and returns the segment's id as known by the manager.

Definition at line 327 of file colorInterpolationManager.cxx.

int ColorInterpolationManager::add_sinusoid ( const float  time_begin = 0.0f,
const float  time_end = 1.0f,
const Colorf  color_a = Colorf(1.0f,0.0f,0.0f,1.0f),
const Colorf  color_b = Colorf(0.0f,1.0f,0.0f,1.0f),
const float  period = 1.0f,
const bool  is_modulated = true 
)

Adds a stepwave segment of two colors and a specified period to the manager and returns the segment's id as known by the manager.

Definition at line 362 of file colorInterpolationManager.cxx.

int ColorInterpolationManager::add_stepwave ( const float  time_begin = 0.0f,
const float  time_end = 1.0f,
const Colorf  color_a = Colorf(1.0f,0.0f,0.0f,1.0f),
const Colorf  color_b = Colorf(0.0f,1.0f,0.0f,1.0f),
const float  width_a = 0.5f,
const float  width_b = 0.5f,
const bool  is_modulated = true 
)

Adds a stepwave segment of two colors to the manager and returns the segment's id as known by the manager.

Definition at line 344 of file colorInterpolationManager.cxx.

void ColorInterpolationManager::clear_segment ( const int  seg_id)

Removes the segment of 'id' from the manager.

Definition at line 378 of file colorInterpolationManager.cxx.

void ColorInterpolationManager::clear_to_initial ( )

Removes all segments from the manager.

Definition at line 396 of file colorInterpolationManager.cxx.

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

Colorf ColorInterpolationManager::generateColor ( const float  interpolated_time)

For time 'interpolated_time', this returns the additive composite color of all segments that influence that instant in the particle's lifetime.

If no segments cover that time, the manager's default color is returned.

Definition at line 411 of file colorInterpolationManager.cxx.

References ColorInterpolationSegment::get_time_begin(), ColorInterpolationSegment::get_time_end(), ColorInterpolationSegment::interpolateColor(), ColorInterpolationSegment::is_enabled(), and ColorInterpolationSegment::is_modulated().

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
ColorInterpolationSegment * ColorInterpolationManager::get_segment ( const int  seg_id) [inline]

Returns the segment that corresponds to 'seg_id'.

Definition at line 284 of file colorInterpolationManager.I.

string ColorInterpolationManager::get_segment_id_list ( ) [inline]

Returns a space delimited list of all of the ids in the manager at the time.

Definition at line 302 of file colorInterpolationManager.I.

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void ColorInterpolationManager::set_default_color ( const Colorf c) [inline]

Sets the color to used if no segments are present.

Definition at line 273 of file colorInterpolationManager.I.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations