|
Purpose:
|
Defines a texture space.
|
|
|
Derivation:
|
RH_TEXTURE_SPACE : RH_ENTITY : ENTITY : ACIS_OBJECT : -
|
|
|
SAT Identifier:
|
"rh_texture_space"
|
|
|
Filename:
|
rbase/rnd_husk/include/rh_enty.hxx
|
|
|
Description:
|
RH_TEXTURE_SPACE entities assist in the production of a shading effect known as a wrapped texture. A wrapped texture produces the effect of a sheet of paper shrink wrapped onto the surface of a solid object. A texture space uses one of several texture space shaders to map between the coordinate system of the sheet and the coordinate system of the surface of the solid object. Texture space arguments are treated in a similar fashion to those of material components.
|
|
|
References:
|
by RBASE
|
ATTRIB_RENDER
|
|
|
Constructor:
|
public: RH_TEXTURE_SPACE::RH_TEXTURE_SPACE
();
|
|
|
C++ allocation constructor requests memory for this object but does not populate it. The allocation constructor is used primarily by restore. Applications should call this constructor only with the overloaded
new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.
|
|
|
|
|
|
|
public: RH_TEXTURE_SPACE::RH_TEXTURE_SPACE
(
|
|
|
const char* name
|
// type of texture space
|
|
|
);
|
|
|
C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments. Applications should call this constructor only with the overloaded
new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.
|
|
|
Constructs a texture space of the type specified by the character string. This string should be the name of an implemented shader, such as "x" or "cylindrical" depending on the renderer.
|
|
|
|
|
|
|
public: RH_TEXTURE_SPACE::RH_TEXTURE_SPACE
(
|
|
|
RH_TEXTURE_SPACE* old
|
// old texture space
|
|
|
);
|
|
|
C++ copy constructor requests memory for this object and populates it with the data from the object supplied as an argument. Applications should call this constructor only with the overloaded
new operator, because this reserves the memory on the heap, a requirement to support roll back and history management.
|
|
|
|
|
|
Destructor:
|
public: virtual void RH_TEXTURE_SPACE::lose
();
|
|
|
Posts a delete bulletin to the bulletin board indicating the instance is no longer used in the active model. The
lose methods for attached attributes are also called.
|
|
|
|
|
|
|
protected: virtual
|
|
|
RH_TEXTURE_SPACE::~RH_TEXTURE_SPACE ();
|
|
|
This
C++ destructor should never be called directly. Instead, applications should use the overloaded
lose method inherited from the
ENTITY class, because this supports history management. (For example,
x=new RH_TEXTURE_SPACE(...) then later
x->lose.)
|
|
|
|
|
Methods:
|
public: virtual void RH_TEXTURE_SPACE::add
();
|
|
|
Increments the use count.
|
|
|
|
|
|
|
public: void RH_TEXTURE_SPACE::debug_details
(
|
|
|
FILE* fp
|
// debug file
|
|
|
) const;
|
|
|
Supports the debug mechanism by providing details of the texture space.
|
|
|
|
|
|
|
public: virtual void RH_TEXTURE_SPACE::debug_ent
(
|
|
|
FILE*
|
// file pointer
|
|
|
) const;
|
|
|
Prints the type and address of this object, roll back pointer, attributes, and any unknown subtype information to the specified file. Refer to the
ENTITY class for more details.
|
|
|
|
|
|
|
public:virtual logical RH_TEXTURE_SPACE::deletable () const;
|
|
|
Usually use counted entities are marked not deletable because their lifetime is controlled by the entities that point to them.
|
|
|
|
|
|
|
public: virtual int RH_TEXTURE_SPACE::identity
(
|
|
|
int
|
|
// level
|
|
|
|
= 0
|
|
|
) const;
|
|
|
If
level is unspecified or 0, returns the type identifier
RH_TEXTURE_SPACE_TYPE. If
level is specified, returns
<class>_TYPE for that level of derivation from
ENTITY. The level of this class is defined as
RH_TEXTURE_SPACE_LEVEL.
|
|
|
|
|
|
|
public: virtual logical
|
|
|
RH_TEXTURE_SPACE::is_deepcopyable () const;
|
|
|
Returns
TRUE if this can be deep copied.
|
|
|
|
|
|
|
public: virtual logical RH_TEXTURE_SPACE::
|
|
|
is_use_counted () const;
|
|
|
Returns
TRUE
if use counting is turned on.
|
|
|
|
|
|
|
public:virtual void RH_TEXTURE_SPACE::remove (
|
|
|
logical lose_if_zero
|
// toggle
|
|
|
= TRUE
|
|
|
);
|
|
|
Decrements the use count and loses the entity if the count reaches zero and the flag is true.
|
|
|
|
|
|
|
public: void RH_TEXTURE_SPACE::restore_common
();
|
|
|
The
RESTORE_DEF macro expands to the
restore_common method, which is used in reading information from a SAT file. This method is never called directly. It is called by a higher hierarchical function if an item in the SAT file is determined to be of this class type. An instance of this class will already have been created through the allocation constructor. This method then populates the class instance with the appropriate data from the SAT file.
|
|
|
rh_restore_string( name )
|
name
|
|
rh_restore_pi_shader( th, RH_TEXTURE_SPACE_SHADER, name )
|
|
|
|
|
|
|
public:virtual void RH_TEXTURE_SPACE::set_use_count (
|
|
|
int val
|
// value
|
|
|
);
|
|
|
Set the use count.
|
|
|
|
|
|
|
public: virtual const char*
|
|
|
RH_TEXTURE_SPACE::type_name () const;
|
|
|
Returns the string "rh_texture_space".
|
|
|
|
|
|
|
public: virtual int RH_TEXTURE_SPACE::use_count
() const;
|
|
|
Enables use count.
|
|
|
Internal Use:
|
save, save_common
|
|
|
|
|
|
Related Fncs:
|
is_RH_TEXTURE_SPACE
|