Function Index Class Index

Select_Segment Class Reference

#include <hic_wrap.h>

Public Member Functions

const char * GetName ()
 
 Select_Segment (HC_KEY key, const char *name, void *data=0)
 
virtual void select_segment (HIC_Rendition const *nr, HIC_Segment_Info const *si)
 
virtual ~Select_Segment ()
 

Protected Member Functions

void * GetData ()
 

Detailed Description

The Select_Segment class is a base class used to define and set a callback at the "select segment" callback point during the HOOPS update cycle. To use this class, derive your own child class from it and implement the method select_segment. For more information on how to define and set callbacks as a C++/C/Java Developer, please see the HOOPS/3dGS Programming Guide.

Constructor & Destructor Documentation

Select_Segment::Select_Segment ( HC_KEY  key,
const char *  name,
void *  data = 0 
)

Constructs a Select_Segment Callback object.

Parameters
keyKey to the segment on which the callback is set.
nameThe name of the callback.
dataOptional pointer to user data that can then be accessed from the callback.
virtual Select_Segment::~Select_Segment ( )
virtual

Deletes the callback object.

Member Function Documentation

void* Select_Segment::GetData ( )
protected

Returns the pointer to the user data that may have been provided when the callback was created.

const char* Select_Segment::GetName ( )

Returns the name of the callback.

virtual void Select_Segment::select_segment ( HIC_Rendition const *  nr,
HIC_Segment_Info const *  si 
)
inlinevirtual

The function you implement for your callback.

Parameters
nrA pointer to a const HIC_Rendition
siA pointer to a const HIC_Segment_Info

The documentation for this class was generated from the following file: