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

ColorInterpolationSegment Class Reference

A single unit of interpolation. More...

#include "colorInterpolationManager.h"

Inheritance diagram for ColorInterpolationSegment:
ReferenceCount MemoryBase

List of all members.

Public Member Functions

 ColorInterpolationSegment (ColorInterpolationFunction *function, const float &time_begin, const float &time_end, const bool is_modulated, const int id)
 constructor
 ColorInterpolationSegment (const ColorInterpolationSegment &s)
 copy constructor
virtual ~ColorInterpolationSegment ()
 destructor
TypedReferenceCountget_function () const
 Returns a reference to the function object corresponding to this segment.
int get_id () const
 Returns the id assigned to this segment by the manager that created it.
int get_ref_count () const
 Returns the current reference count.
float get_time_begin () const
 Returns the point in the particle's lifetime at which this segment begins its effect.
float get_time_end () const
 Returns the point in the particle's lifetime at which this segment's effect stops.
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.
Colorf interpolateColor (const float t) const
 Returns the interpolated color according to the segment's function and start and end times.
bool is_enabled () const
 Returns whether the segments effects are being applied.
bool is_modulated () const
 Returns whether the function is additive or modulated.
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 *)
void operator delete (void *ptr)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
void ref () const
 Explicitly increments the reference count.
void set_enabled (const bool enabled)
 Sets whether the segments effects should be applied.
void set_function (ColorInterpolationFunction *function)
 Sets the function that the segment will use for its interpolation calculations.
void set_is_modulated (const bool flag)
 Sets how the function is applied to the final color.
void set_time_begin (const float time)
 Sets the point in the particle's lifetime at which this segment begins its effect.
void set_time_end (const float time)
 Sets the point in the particle's lifetime at which this segment's effect ends.
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.
 PT (ColorInterpolationFunction) _color_inter_func

Protected Attributes

bool _enabled
const int _id
bool _is_modulated
float _t_begin
float _t_end
float _t_total

Detailed Description

A single unit of interpolation.

The begin and end times are interpolated over the lifetime of the particle, thus have the range of [0,1]. Each segment also has a function associated with it.

Definition at line 241 of file colorInterpolationManager.h.


Constructor & Destructor Documentation

ColorInterpolationSegment::ColorInterpolationSegment ( ColorInterpolationFunction function,
const float &  time_begin,
const float &  time_end,
const bool  is_modulated,
const int  id 
)

constructor

Definition at line 199 of file colorInterpolationManager.cxx.

ColorInterpolationSegment::ColorInterpolationSegment ( const ColorInterpolationSegment s)

copy constructor

Definition at line 220 of file colorInterpolationManager.cxx.

ColorInterpolationSegment::~ColorInterpolationSegment ( ) [virtual]

destructor

Definition at line 237 of file colorInterpolationManager.cxx.


Member Function Documentation

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().

TypedReferenceCount * ColorInterpolationSegment::get_function ( ) const [inline]

Returns a reference to the function object corresponding to this segment.

Definition at line 138 of file colorInterpolationManager.I.

int ColorInterpolationSegment::get_id ( ) const [inline]

Returns the id assigned to this segment by the manager that created it.

Definition at line 198 of file colorInterpolationManager.I.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
float ColorInterpolationSegment::get_time_begin ( ) const [inline]

Returns the point in the particle's lifetime at which this segment begins its effect.

It is an interpolated value in the range [0,1].

Definition at line 151 of file colorInterpolationManager.I.

Referenced by ColorInterpolationManager::generateColor().

float ColorInterpolationSegment::get_time_end ( ) const [inline]

Returns the point in the particle's lifetime at which this segment's effect stops.

It is an interpolated value in the range [0,1].

Definition at line 164 of file colorInterpolationManager.I.

Referenced by ColorInterpolationManager::generateColor().

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().

Colorf ColorInterpolationSegment::interpolateColor ( const float  t) const

Returns the interpolated color according to the segment's function and start and end times.

't' is a value in [0-1] where corresponds to beginning of the segment and 1 corresponds to the end.

Definition at line 250 of file colorInterpolationManager.cxx.

Referenced by ColorInterpolationManager::generateColor().

bool ColorInterpolationSegment::is_enabled ( ) const [inline]

Returns whether the segments effects are being applied.

Definition at line 186 of file colorInterpolationManager.I.

Referenced by ColorInterpolationManager::generateColor().

bool ColorInterpolationSegment::is_modulated ( ) const [inline]

Returns whether the function is additive or modulated.

Definition at line 175 of file colorInterpolationManager.I.

Referenced by ColorInterpolationManager::generateColor().

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 ColorInterpolationSegment::set_enabled ( const bool  enabled) [inline]

Sets whether the segments effects should be applied.

Definition at line 262 of file colorInterpolationManager.I.

void ColorInterpolationSegment::set_function ( ColorInterpolationFunction function) [inline]

Sets the function that the segment will use for its interpolation calculations.

Definition at line 210 of file colorInterpolationManager.I.

void ColorInterpolationSegment::set_is_modulated ( const bool  flag) [inline]

Sets how the function is applied to the final color.

If true, the value is multiplied. If false, the value is simply added. Default is true.

Definition at line 251 of file colorInterpolationManager.I.

void ColorInterpolationSegment::set_time_begin ( const float  time) [inline]

Sets the point in the particle's lifetime at which this segment begins its effect.

It is an interpolated value in the range [0,1].

Definition at line 223 of file colorInterpolationManager.I.

void ColorInterpolationSegment::set_time_end ( const float  time) [inline]

Sets the point in the particle's lifetime at which this segment's effect ends.

It is an interpolated value in the range [0,1].

Definition at line 237 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