cgv
Loading...
Searching...
No Matches
cgv::base::attach_slot Class Reference

interface for an attachment slot that can store a base pointer More...

#include <attach_slot.h>

Public Member Functions

 attach_slot ()
 init the user data
 
void attach (base_ptr attachment_object, void *user_data=0)
 attach object to attachment slot
 
void attach (base_ptr attachment_object, int user_data)
 attach object to attachment slot
 
base_ptr get_attachment () const
 return current attachment
 
voidget_attachement_data () const
 return current attachment
 
int get_attachement_data_int () const
 return current attachment
 

Protected Attributes

base_ptr attachment
 allow to attach some object to group
 
voidattachment_user_data
 allow to add user data to the attachment
 

Detailed Description

interface for an attachment slot that can store a base pointer

Definition at line 11 of file attach_slot.h.

Constructor & Destructor Documentation

◆ attach_slot()

cgv::base::attach_slot::attach_slot ( )

init the user data

Definition at line 7 of file attach_slot.cxx.

References attachment_user_data.

Member Function Documentation

◆ attach() [1/2]

void cgv::base::attach_slot::attach ( base_ptr  attachment_object,
int  user_data 
)

attach object to attachment slot

Definition at line 20 of file attach_slot.cxx.

References attach().

◆ attach() [2/2]

void cgv::base::attach_slot::attach ( base_ptr  attachment_object,
void user_data = 0 
)

attach object to attachment slot

attach object to group

Definition at line 14 of file attach_slot.cxx.

References attachment, and attachment_user_data.

Referenced by attach().

◆ get_attachement_data()

void * cgv::base::attach_slot::get_attachement_data ( ) const

return current attachment

Definition at line 32 of file attach_slot.cxx.

References attachment_user_data.

◆ get_attachment()

base_ptr cgv::base::attach_slot::get_attachment ( ) const

return current attachment

Definition at line 26 of file attach_slot.cxx.

References attachment.

Member Data Documentation

◆ attachment

base_ptr cgv::base::attach_slot::attachment
protected

allow to attach some object to group

Definition at line 15 of file attach_slot.h.

Referenced by attach(), and get_attachment().

◆ attachment_user_data

void* cgv::base::attach_slot::attachment_user_data
protected

allow to add user data to the attachment

Definition at line 17 of file attach_slot.h.

Referenced by attach(), attach_slot(), and get_attachement_data().


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