Panda3D
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
EggMaterial Class Reference
Inheritance diagram for EggMaterial:
EggNode EggNamedObject EggObject Namable TypedReferenceCount TypedObject ReferenceCount

Public Types

enum  Equivalence { E_attributes = 1, E_mref_name = 2 }
 

Public Member Functions

 __init__ (const EggMaterial copy)
 
 __init__ (str mref_name)
 
 clearAmb ()
 
 clearBase ()
 
 clearDiff ()
 
 clearEmit ()
 
 clearIor ()
 
 clearLocal ()
 
 clearMetallic ()
 
 clearRoughness ()
 
 clearShininess ()
 
 clearSpec ()
 
LColor getAmb ()
 It is legal to call this even if has_amb() returns false. More...
 
LColor getBase ()
 It is legal to call this even if has_base() returns false. More...
 
LColor getDiff ()
 It is legal to call this even if has_diff() returns false. More...
 
LColor getEmit ()
 It is legal to call this even if has_emit() returns false. More...
 
double getIor ()
 
bool getLocal ()
 
double getMetallic ()
 
double getRoughness ()
 
double getShininess ()
 
LColor getSpec ()
 It is legal to call this even if has_spec() returns false. More...
 
bool hasAmb ()
 
bool hasBase ()
 
bool hasDiff ()
 
bool hasEmit ()
 
bool hasIor ()
 
bool hasLocal ()
 
bool hasMetallic ()
 
bool hasRoughness ()
 
bool hasShininess ()
 
bool hasSpec ()
 
bool isEquivalentTo (const EggMaterial other, int eq)
 Returns true if the two materials are equivalent in all relevant properties (according to eq), false otherwise. More...
 
 setAmb (const LColor amb)
 
 setBase (const LColor base)
 
 setDiff (const LColor diff)
 
 setEmit (const LColor emit)
 
 setIor (double ior)
 
 setLocal (bool local)
 
 setMetallic (double metallic)
 
 setRoughness (double roughness)
 
 setShininess (double shininess)
 
 setSpec (const LColor spec)
 
bool sortsLessThan (const EggMaterial other, int eq)
 An ordering operator to compare two materials for sorting order. More...
 
- Public Member Functions inherited from EggNode
 applyTexmats ()
 Applies the texture matrices to the UV's of the vertices that reference them, and then removes the texture matrices from the textures themselves. More...
 
EggRenderMode determineAlphaMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has an alpha_mode other than AM_unspecified. More...
 
EggRenderMode determineBin ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a bin specified. More...
 
bool determineDecal ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "decal" flag set. More...
 
EggRenderMode determineDepthOffset ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a depth_offset specified. More...
 
EggRenderMode determineDepthTestMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a depth_test_mode other than DTM_unspecified. More...
 
EggRenderMode determineDepthWriteMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a depth_write_mode other than DWM_unspecified. More...
 
EggRenderMode determineDrawOrder ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a draw_order specified. More...
 
bool determineIndexed ()
 Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "indexed" scalar set. More...
 
EggRenderMode determineVisibilityMode ()
 Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this node that has a visibility_mode other than VM_unspecified. More...
 
 flattenTransforms ()
 Removes any transform and instance records from this node in the scene graph and below. More...
 
int getDepth ()
 Returns the number of nodes above this node in the egg hierarchy. More...
 
const LMatrix4d getNodeFrame ()
 Returns the coordinate frame of the node itself. More...
 
const LMatrix4d getNodeFrameInv ()
 Returns the inverse of the matrix returned by get_node_frame(). More...
 
const LMatrix4d getNodeFrameInvPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame_inv() matrix. More...
 
const LMatrix4d getNodeFramePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame() matrix. More...
 
const LMatrix4d getNodeToVertex ()
 Returns the transformation matrix suitable for converting vertices in the coordinate space of the node to the appropriate coordinate space for storing in the egg file. More...
 
const LMatrix4d getNodeToVertexPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_to_vertex() matrix. More...
 
EggGroupNode getParent ()
 
const LMatrix4d getVertexFrame ()
 Returns the coordinate frame of the vertices referenced by primitives at or under this node. More...
 
const LMatrix4d getVertexFrameInv ()
 Returns the inverse of the matrix returned by get_vertex_frame(). More...
 
const LMatrix4d getVertexFrameInvPtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame_inv() matrix. More...
 
const LMatrix4d getVertexFramePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame() matrix. More...
 
const LMatrix4d getVertexToNode ()
 Returns the transformation matrix suitable for converting the vertices as read from the egg file into the coordinate space of the node. More...
 
const LMatrix4d getVertexToNodePtr ()
 Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_to_node() matrix. More...
 
bool isAnimMatrix ()
 Returns true if this node represents a table of animation transformation data, false otherwise. More...
 
bool isJoint ()
 Returns true if this particular node represents a <Joint> entry or not. More...
 
bool isLocalCoord ()
 Returns true if this node's vertices are not in the global coordinate space. More...
 
bool isUnderInstance ()
 Returns true if there is an <Instance> node somewhere in the egg tree at or above this node, false otherwise. More...
 
bool isUnderTransform ()
 Returns true if there is a <Transform> entry somewhere in the egg tree at or above this node, false otherwise. More...
 
EggNode operator= (const EggNode copy)
 
bool parseEgg (str egg_syntax)
 Parses the egg syntax given in the indicate string as if it had been read from the egg file within this object's definition. More...
 
int renameNode (VectorString strip_prefix)
 Rename by stripping out the prefix. More...
 
 testUnderIntegrity ()
 
 transform (const LMatrix4d mat)
 Applies the indicated transformation to the node and all of its descendants. More...
 
 transformVerticesOnly (const LMatrix4d mat)
 Applies the indicated transformation only to vertices that appear in global space within vertex pools at this node and below. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from EggNamedObject
 __init__ (const EggNamedObject copy)
 
 __init__ (str name)
 
EggNamedObject operator= (const EggNamedObject copy)
 
 output (Ostream out)
 
- Public Member Functions inherited from EggObject
 __init__ ()
 
 __init__ (const EggObject copy)
 
 clearUserData ()
 Removes all user data pointers from the node. More...
 
 clearUserData (TypeHandle type)
 Removes the user data pointer of the indicated type. More...
 
EggUserData getUserData ()
 Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored. More...
 
EggUserData getUserData (TypeHandle type)
 Returns the user data pointer of the indicated type, if it exists, or NULL if it does not. More...
 
bool hasUserData ()
 Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise. More...
 
bool hasUserData (TypeHandle type)
 Returns true if the user data pointer of the indicated type has been set, false otherwise. More...
 
EggObject operator= (const EggObject copy)
 
 setUserData (EggUserData user_data)
 Sets the user data associated with this object. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
 output (Ostream out)
 Outputs the Namable. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from EggNode
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from EggNamedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from EggObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Public Attributes

LColor amb
 It is legal to call this even if has_amb() returns false. More...
 
LColor base
 It is legal to call this even if has_base() returns false. More...
 
LColor diff
 It is legal to call this even if has_diff() returns false. More...
 
LColor emit
 It is legal to call this even if has_emit() returns false. More...
 
double ior
 
bool local
 
double metallic
 
double roughness
 
double shininess
 
LColor spec
 It is legal to call this even if has_spec() returns false. More...
 
- Public Attributes inherited from EggNode
int depth
 Returns the number of nodes above this node in the egg hierarchy. More...
 
EggGroupNode parent
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 
- Public Attributes inherited from Namable
const String name
 

Member Enumeration Documentation

◆ Equivalence

Enumerator
E_attributes 
E_mref_name 

Member Function Documentation

◆ __init__() [1/2]

__init__ ( const EggMaterial  copy)

◆ __init__() [2/2]

__init__ ( str  mref_name)

◆ clearAmb()

clearAmb ( )

◆ clearBase()

clearBase ( )
Since
1.10.0

◆ clearDiff()

clearDiff ( )

◆ clearEmit()

clearEmit ( )

◆ clearIor()

clearIor ( )
Since
1.10.0

◆ clearLocal()

clearLocal ( )

◆ clearMetallic()

clearMetallic ( )
Since
1.10.0

◆ clearRoughness()

clearRoughness ( )
Since
1.10.0

◆ clearShininess()

clearShininess ( )

◆ clearSpec()

clearSpec ( )

◆ getAmb()

LColor getAmb ( )

It is legal to call this even if has_amb() returns false.

If so, it simply returns the default amb color.

◆ getBase()

LColor getBase ( )

It is legal to call this even if has_base() returns false.

If so, it simply returns the default base color.

Since
1.10.0

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDiff()

LColor getDiff ( )

It is legal to call this even if has_diff() returns false.

If so, it simply returns the default diff color.

◆ getEmit()

LColor getEmit ( )

It is legal to call this even if has_emit() returns false.

If so, it simply returns the default emit color.

◆ getIor()

double getIor ( )
Since
1.10.0

◆ getLocal()

bool getLocal ( )

◆ getMetallic()

double getMetallic ( )
Since
1.10.0

◆ getRoughness()

double getRoughness ( )
Since
1.10.0

◆ getShininess()

double getShininess ( )

◆ getSpec()

LColor getSpec ( )

It is legal to call this even if has_spec() returns false.

If so, it simply returns the default spec color.

◆ hasAmb()

bool hasAmb ( )

◆ hasBase()

bool hasBase ( )
Since
1.10.0

◆ hasDiff()

bool hasDiff ( )

◆ hasEmit()

bool hasEmit ( )

◆ hasIor()

bool hasIor ( )
Since
1.10.0

◆ hasLocal()

bool hasLocal ( )

◆ hasMetallic()

bool hasMetallic ( )
Since
1.10.0

◆ hasRoughness()

bool hasRoughness ( )
Since
1.10.0

◆ hasShininess()

bool hasShininess ( )

◆ hasSpec()

bool hasSpec ( )

◆ isEquivalentTo()

bool isEquivalentTo ( const EggMaterial  other,
int  eq 
)

Returns true if the two materials are equivalent in all relevant properties (according to eq), false otherwise.

The Equivalence parameter, eq, should be set to the bitwise OR of the following properties, according to what you consider relevant:

EggMaterial::E_attributes: All material attributes (diff, spec, etc.) except MRef name.

EggMaterial::E_mref_name: The MRef name.

◆ setAmb()

setAmb ( const LColor  amb)

◆ setBase()

setBase ( const LColor  base)
Since
1.10.0

◆ setDiff()

setDiff ( const LColor  diff)

◆ setEmit()

setEmit ( const LColor  emit)

◆ setIor()

setIor ( double  ior)
Since
1.10.0

◆ setLocal()

setLocal ( bool  local)

◆ setMetallic()

setMetallic ( double  metallic)
Since
1.10.0

◆ setRoughness()

setRoughness ( double  roughness)
Since
1.10.0

◆ setShininess()

setShininess ( double  shininess)

◆ setSpec()

setSpec ( const LColor  spec)

◆ sortsLessThan()

bool sortsLessThan ( const EggMaterial  other,
int  eq 
)

An ordering operator to compare two materials for sorting order.

This imposes an arbitrary ordering useful to identify unique materials, according to the indicated Equivalence factor. See is_equivalent_to().

Member Data Documentation

◆ amb

LColor amb

It is legal to call this even if has_amb() returns false.

If so, it simply returns the default amb color.

◆ base

LColor base

It is legal to call this even if has_base() returns false.

If so, it simply returns the default base color.

Since
1.10.0

◆ diff

LColor diff

It is legal to call this even if has_diff() returns false.

If so, it simply returns the default diff color.

◆ emit

LColor emit

It is legal to call this even if has_emit() returns false.

If so, it simply returns the default emit color.

◆ ior

double ior
Since
1.10.0

◆ local

bool local

◆ metallic

double metallic
Since
1.10.0

◆ roughness

double roughness
Since
1.10.0

◆ shininess

double shininess

◆ spec

LColor spec

It is legal to call this even if has_spec() returns false.

If so, it simply returns the default spec color.