Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

SampleClass Class Reference

A basic description of the function and purpose of SampleClass. More...

#include <sampleClass.h>

Inheritance diagram for SampleClass:

TypedObject List of all members.

Public Types

enum  NestedEnum { NE_case_one, NE_case_two }

Public Member Functions

 SampleClass ()
 SampleClass (const SampleClass &copy)
 ~SampleClass ()
void set_flag (int flag)
 A few sentences describing the purpose of flag, the legal values it may be set to, and the implications of setting it to certain values.

int get_flag () const
 A few sentences describing the purpose of flag, the legal values it may be set to, and the implications of setting it to certain values.

int public_method ()
 A few sentences describing what public_method is supposed to do and why you'd want to call it.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.

bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.


Static Public Member Functions

TypeHandle get_class_type ()
void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.


Public Attributes

bool _public_data_member

Protected Member Functions

bool protected_method ()
 A few sentences describing what protected_method is supposed to do.


Private Member Functions

void private_method ()
 A few sentences describing what private_method is supposed to do.


Private Attributes

NestedEnumType _private_data_member
int _flag

Static Private Attributes

TypeHandle _type_handle

Detailed Description

A basic description of the function and purpose of SampleClass.

Note that class names are generally mixed case, no underscore, beginning with a capital letter.

Definition at line 53 of file sampleClass.h.


Member Enumeration Documentation

enum SampleClass::NestedEnum
 

Enumeration values:
NE_case_one 
NE_case_two 

Definition at line 55 of file sampleClass.h.


Constructor & Destructor Documentation

SampleClass::SampleClass  ) 
 

Definition at line 34 of file sampleClass.cxx.

References _flag, NE_case_one, and NE_case_two.

SampleClass::SampleClass const SampleClass &  copy  )  [inline]
 

Definition at line 31 of file sampleClass.I.

SampleClass::~SampleClass  )  [inline]
 

Definition at line 46 of file sampleClass.I.

References _flag, and INLINE.


Member Function Documentation

virtual TypeHandle SampleClass::force_init_type void   )  [inline, virtual]
 

Implements TypedObject.

Definition at line 118 of file sampleClass.h.

TypeHandle SampleClass::get_class_type void   )  [inline, static]
 

Reimplemented from TypedObject.

Definition at line 107 of file sampleClass.h.

int SampleClass::get_flag  )  const [inline]
 

A few sentences describing the purpose of flag, the legal values it may be set to, and the implications of setting it to certain values.

Definition at line 79 of file sampleClass.I.

virtual TypeHandle SampleClass::get_type void   )  const [inline, virtual]
 

Implements TypedObject.

Definition at line 115 of file sampleClass.h.

int TypedObject::get_type_index  )  const [inline, inherited]
 

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

Definition at line 71 of file typedObject.I.

References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

void SampleClass::init_type void   )  [inline, static]
 

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedObject.

Definition at line 110 of file sampleClass.h.

bool TypedObject::is_exact_type TypeHandle  handle  )  const [inline, inherited]
 

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.

Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type TypeHandle  handle  )  const [inline, inherited]
 

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.

Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

void SampleClass::private_method  )  [private]
 

A few sentences describing what private_method is supposed to do.

Definition at line 92 of file sampleClass.cxx.

bool SampleClass::protected_method  )  [protected]
 

A few sentences describing what protected_method is supposed to do.

Definition at line 72 of file sampleClass.cxx.

int SampleClass::public_method  ) 
 

A few sentences describing what public_method is supposed to do and why you'd want to call it.

Definition at line 48 of file sampleClass.cxx.

void SampleClass::set_flag int  flag  )  [inline]
 

A few sentences describing the purpose of flag, the legal values it may be set to, and the implications of setting it to certain values.

Definition at line 62 of file sampleClass.I.

References _flag.


Member Data Documentation

int SampleClass::_flag [private]
 

Definition at line 99 of file sampleClass.h.

Referenced by SampleClass(), set_flag(), and ~SampleClass().

NestedEnumType SampleClass::_private_data_member [private]
 

Definition at line 98 of file sampleClass.h.

bool SampleClass::_public_data_member
 

Definition at line 94 of file sampleClass.h.

TypeHandle SampleClass::_type_handle [static, private]
 

Reimplemented from TypedObject.

Definition at line 24 of file sampleClass.cxx.


The documentation for this class was generated from the following files:
Generated on Fri May 2 00:54:54 2003 for Panda by doxygen1.3