Panda3D
Public Member Functions | Static Public Member Functions

Material Class Reference

Defines the way an object appears in the presence of lighting. More...

Inheritance diagram for Material:
TypedWritableReferenceCount Namable TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

List of all members.

Public Member Functions

 Material (Material const copy)
 Material (string name)
 Material ()
 clearAmbient ()
 Removes the explicit ambient color from the material.
 clearDiffuse ()
 Removes the explicit diffuse color from the material.
 clearEmission ()
 Removes the explicit emission color from the material.
 clearName ()
 Resets the Namable's name to empty.
 clearSpecular ()
 Removes the explicit specular color from the material.
int compareTo (Material const other)
 Returns a number less than zero if this material sorts before the other one, greater than zero if it sorts after, or zero if they are equivalent.
string encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.
bool encodeToBamStream (basic_stringchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
bool encodeToBamStream (basic_stringchar data)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
VBase4 const getAmbient ()
 Returns the ambient color setting, if it has been set.
UpdateSeq getBamModified ()
 Returns the current bam_modified counter.
VBase4 const getDiffuse ()
 Returns the diffuse color setting, if it has been set.
VBase4 const getEmission ()
 Returns the emission color setting, if it has been set.
bool getLocal ()
 Returns the local viewer flag.
string getName ()
int getRefCount ()
 Returns the current reference count.
float getShininess ()
 Returns the shininess exponent of the material.
VBase4 const getSpecular ()
 Returns the specular color setting, if it has been set.
bool getTwoside ()
 Returns the state of the two-sided lighting flag.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool hasAmbient ()
 Returns true if the ambient color has been explicitly set for this material, false otherwise.
bool hasDiffuse ()
 Returns true if the diffuse color has been explicitly set for this material, false otherwise.
bool hasEmission ()
 Returns true if the emission color has been explicitly set for this material, false otherwise.
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty.
bool hasSpecular ()
 Returns true if the specular color has been explicitly set for this material, false otherwise.
bool isAttribLocked ()
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
bool operator!= (Material const other)
bool operator< (Material const other)
Material operator= (Material const copy)
bool operator== (Material const other)
 output (ostream out)
 Outputs the Namable.
PyObject reduce (PyObject self)
 This special Python method is implement to provide support for the pickle module.
PyObject reducePersist (PyObject self, PyObject pickler)
 This special Python method is implement to provide support for the pickle module.
 ref ()
 Explicitly increments the reference count.
 setAmbient (VBase4 const color)
 Specifies the ambient color setting of the material.
 setAttribLock ()
 setDiffuse (VBase4 const color)
 Specifies the diffuse color setting of the material.
 setEmission (VBase4 const color)
 Specifies the emission color setting of the material.
 setLocal (bool local)
 Sets the local viewer flag.
 setName (string name)
 setShininess (float shininess)
 Sets the shininess exponent of the material.
 setSpecular (VBase4 const color)
 Specifies the diffuse color setting of the material.
 setTwoside (bool twoside)
 Set this true to enable two-sided lighting.
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unref ()
 Explicitly decrements the reference count.
 write (ostream out, int indent)

Static Public Member Functions

static TypedWritableReferenceCount decodeFromBamStream (string data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
static TypedWritableReferenceCount decodeFromBamStream (string data)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.
static TypeHandle getClassType ()
static Material getDefault ()
 Returns the default material.

Detailed Description

Defines the way an object appears in the presence of lighting.

A material is only necessary if lighting is to be enabled; otherwise, the material isn't used.


Constructor & Destructor Documentation

Material ( Material const  copy)
Material ( string  name)
Material ( )

Member Function Documentation

clearAmbient ( )

Removes the explicit ambient color from the material.

clearDiffuse ( )

Removes the explicit diffuse color from the material.

clearEmission ( )

Removes the explicit emission color from the material.

clearName ( ) [inherited]

Resets the Namable's name to empty.

Reimplemented in AsyncTask.

clearSpecular ( )

Removes the explicit specular color from the material.

int compareTo ( Material const  other)

Returns a number less than zero if this material sorts before the other one, greater than zero if it sorts after, or zero if they are equivalent.

The sorting order is arbitrary and largely meaningless, except to differentiate different materials.

static TypedWritableReferenceCount decodeFromBamStream ( string  data,
BamReader  reader 
) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.

Returns NULL on error.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

static TypedWritableReferenceCount decodeFromBamStream ( string  data) [static, inherited]

Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string.

Returns NULL on error.

This method is intended to replace decode_raw_from_bam_stream() when you know the stream in question returns an object of type TypedWritableReferenceCount, allowing for easier reference count management. Note that the caller is still responsible for maintaining the reference count on the return value.

string encodeToBamStream ( ) [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string.

Returns empty string on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data,
BamWriter  writer 
) [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

bool encodeToBamStream ( basic_stringchar  data) [inherited]

Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

Returns true on success, false on failure.

This is a convenience method particularly useful for cases when you are only serializing a single object. If you have many objects to process, it is more efficient to use the same BamWriter to serialize all of them together.

VBase4 const getAmbient ( )

Returns the ambient color setting, if it has been set.

Returns (0,0,0,0) if the ambient color has not been set.

UpdateSeq getBamModified ( ) [inherited]

Returns the current bam_modified counter.

This counter is normally incremented automatically whenever the object is modified.

static TypeHandle getClassType ( ) [static]

Reimplemented from Namable.

static Material getDefault ( ) [static]

Returns the default material.

VBase4 const getDiffuse ( )

Returns the diffuse color setting, if it has been set.

Returns (1,1,1,1) if the diffuse color has not been set.

VBase4 const getEmission ( )

Returns the emission color setting, if it has been set.

Returns (0,0,0,0) if the emission color has not been set.

bool getLocal ( )

Returns the local viewer flag.

Set set_local().

string getName ( ) [inherited]

Reimplemented in DynamicTextFont.

int getRefCount ( ) [inherited]

Returns the current reference count.

float getShininess ( )

Returns the shininess exponent of the material.

VBase4 const getSpecular ( )

Returns the specular color setting, if it has been set.

Returns (0,0,0,0) if the specular color has not been set.

bool getTwoside ( )

Returns the state of the two-sided lighting flag.

See set_twoside().

TypeHandle getType ( ) [inherited]

Reimplemented in AnimChannelBase.

int getTypeIndex ( ) [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().

bool hasAmbient ( )

Returns true if the ambient color has been explicitly set for this material, false otherwise.

bool hasDiffuse ( )

Returns true if the diffuse color has been explicitly set for this material, false otherwise.

bool hasEmission ( )

Returns true if the emission color has been explicitly set for this material, false otherwise.

bool hasName ( ) [inherited]

Returns true if the Namable has a nonempty name set, false if the name is empty.

bool hasSpecular ( )

Returns true if the specular color has been explicitly set for this material, false otherwise.

bool isAttribLocked ( )
bool isExactType ( TypeHandle  handle) [inherited]

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

bool isOfType ( TypeHandle  handle) [inherited]

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

markBamModified ( ) [inherited]

Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.

This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients.

bool operator!= ( Material const  other)
bool operator< ( Material const  other)
Material operator= ( Material const  copy)
bool operator== ( Material const  other)
output ( ostream  out)

Outputs the Namable.

This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

Reimplemented from Namable.

PyObject reduce ( PyObject  self) [inherited]

This special Python method is implement to provide support for the pickle module.

This hooks into the native pickle and cPickle modules, but it cannot properly handle self-referential BAM objects.

PyObject reducePersist ( PyObject  self,
PyObject  pickler 
) [inherited]

This special Python method is implement to provide support for the pickle module.

This is similar to __reduce__, but it provides additional support for the missing persistent-state object needed to properly support self-referential BAM objects written to the pickle stream. This hooks into the pickle and cPickle modules implemented in direct/src/stdpy.

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

setAmbient ( VBase4 const  color)

Specifies the ambient color setting of the material.

This will be the multiplied by any ambient lights in effect on the material to set its base color.

This is the color of the object as it appears in the absence of direct light.

If this is not set, the object color will be used.

setAttribLock ( )
setDiffuse ( VBase4 const  color)

Specifies the diffuse color setting of the material.

This will be multiplied by any lights in effect on the material to get the color in the parts of the object illuminated by the lights.

This is the primary color of an object; the color of the object as it appears in direct light, in the absence of highlights.

If this is not set, the object color will be used.

setEmission ( VBase4 const  color)

Specifies the emission color setting of the material.

This is the color of the object as it appears in the absence of any light whatsover, including ambient light. It is as if the object is glowing by this color (although of course it will not illuminate neighboring objects).

If this is not set, the object will not glow by its own light and will only appear visible in the presence of one or more lights.

setLocal ( bool  local)

Sets the local viewer flag.

Set this true to enable camera-relative specular highlights, or false to use orthogonal specular highlights. The default value is true. Applications that use orthogonal projection should specify false.

setName ( string  name) [inherited]

Reimplemented in PGItem, and AsyncTask.

setShininess ( float  shininess)

Sets the shininess exponent of the material.

This controls the size of the specular highlight spot. In general, larger number produce a smaller specular highlight, which makes the object appear shinier. Smaller numbers produce a larger highlight, which makes the object appear less shiny.

setSpecular ( VBase4 const  color)

Specifies the diffuse color setting of the material.

This will be multiplied by any lights in effect on the material to compute the color of specular highlights on the object.

This is the highlight color of an object: the color of small highlight reflections.

If this is not set, highlights will not appear.

setTwoside ( bool  twoside)

Set this true to enable two-sided lighting.

When two-sided lighting is on, both sides of a polygon will be lit by this material. The default is for two-sided lighting to be off, in which case only the front surface is lit.

bool testRefCountIntegrity ( ) [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.

bool testRefCountNonzero ( ) [inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

bool unref ( ) [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, and GeomVertexFormat.

write ( ostream  out,
int  indent 
)
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties