# EggGroup

from pandac.PandaModules import EggGroup

Class : EggGroup
Description : The main glue of the egg hierarchy, this corresponds to the <Group>, <Instance>, and <Joint> type nodes.

## Inheritance:

EggGroup: EggGroupNode EggRenderMode EggTransform
EggGroupNode: EggNode
EggNode: EggNamedObject
EggNamedObject: EggObject Namable
EggObject: TypedReferenceCount
TypedReferenceCount: TypedObject ReferenceCount
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase
Namable:
EggRenderMode:
EggTransform:

## Methods of EggGroup:

EggGroup (Constructor)
addGroupRef
addObjectType
clearBillboardCenter
clearBlendColor
clearCollideMask
clearCollisionName
clearDefaultPose
clearFromCollideMask
clearGroupRefs
clearIndexedFlag
clearIntoCollideMask
clearLod
clearObjectTypes
clearTag
determineAlphaMode
determineBin
determineDecal
determineDepthTestMode
determineDepthWriteMode
determineDrawOrder
determineIndexed
determineVisibilityMode
getBillboardCenter
getBillboardType
getBlendColor
getBlendMode
getBlendOperandA
getBlendOperandB
getClassType
getCollideFlags
getCollideMask
getCollisionName
getCsType
getDartType
getDcsType
getDecalFlag
getDefaultPose
getDirectFlag
getFromCollideMask
getGroupRef
getGroupType
getIndexedFlag
getIntoCollideMask
getLod
getModelFlag
getNofogFlag
getNumGroupRefs
getNumObjectTypes
getObjectType
getPolylightFlag
getPortalFlag
getSwitchFlag
getSwitchFps
getTag
getTexlistFlag
getVertexMembership
hasBillboardCenter
hasBlendColor
hasCollideMask
hasCollisionName
hasDcsType
hasFromCollideMask
hasIndexedFlag
hasIntoCollideMask
hasLod
hasObjectType
hasTag
isInstanceType
isJoint
modifyDefaultPose
operator =
refVertex
removeGroupRef
removeObjectType
setBillboardCenter
setBillboardType
setBlendColor
setBlendMode
setBlendOperandA
setBlendOperandB
setCollideFlags
setCollideMask
setCollisionName
setCsType
setDartType
setDcsType
setDecalFlag
setDefaultPose
setDirectFlag
setFromCollideMask
setGroupType
setIndexedFlag
setIntoCollideMask
setLod
setModelFlag
setNofogFlag
setPolylightFlag
setPortalFlag
setSwitchFlag
setSwitchFps
setTag
setTexlistFlag
setVertexMembership
stealVrefs
stringBillboardType
stringBlendMode
stringBlendOperand
stringCollideFlags
stringCsType
stringDartType
stringDcsType
stringGroupType
testVrefIntegrity
unrefAllVertices
unrefVertex
write
writeBillboardFlags
writeCollideFlags
writeDecalFlags
writeModelFlags
writeObjectTypes
writeRenderMode
writeSwitchFlags
writeTags

## Methods of EggGroupNode:

EggGroupNode (Constructor)
addChild
applyFirstAttribute
applyLastAttribute
clear
clearConnectedShading
empty
findChild
forceFilenames
getClassType
getConnectedShading
getFirstChild
getNextChild
hasAbsolutePathnames
hasNormals
hasPrimitives
isRight
jointHasPrimitives
meshTriangles
operator =
postApplyFlatAttribute
recomputePolygonNormals
recomputeTangentBinormal
recomputeTangentBinormalAuto
recomputeVertexNormals
removeChild
removeInvalidPrimitives
removeUnusedVertices
renameNodes
resolveFilenames
reverseVertexOrdering
size
stealChildren
stripNormals
triangulatePolygons
unifyAttributes

## Methods of EggNode:

applyTexmats
determineAlphaMode
determineBin
determineDecal
determineDepthTestMode
determineDepthWriteMode
determineDrawOrder
determineIndexed
determineVisibilityMode
flattenTransforms
getClassType
getDepth
getNodeFrame
getNodeFrameInv
getNodeFrameInvPtr
getNodeFramePtr
getNodeToVertex
getNodeToVertexPtr
getParent
getVertexFrame
getVertexFrameInv
getVertexFrameInvPtr
getVertexFramePtr
getVertexToNode
getVertexToNodePtr
isAnimMatrix
isJoint
isLocalCoord
isUnderInstance
isUnderTransform
operator =
parseEgg
renameNode
testUnderIntegrity
transform
transformVerticesOnly
write

## Methods of EggNamedObject:

EggNamedObject (Constructor)
getClassType
operator =
output

## Methods of EggObject:

EggObject (Constructor)
clearUserData
getClassType
getUserData
hasUserData
operator =
setUserData

## Methods of TypedReferenceCount:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

## Methods of Namable:

Namable (Constructor)
clearName
getClassType
getName
hasName
operator =
output
setName

## Methods of EggRenderMode:

EggRenderMode (Constructor)
clearBin
clearDrawOrder
getAlphaMode
getBin
getClassType
getDepthTestMode
getDepthWriteMode
getDrawOrder
getVisibilityMode
hasBin
hasDrawOrder
operator !=
operator <
operator =
operator ==
setAlphaMode
setBin
setDepthTestMode
setDepthWriteMode
setDrawOrder
setVisibilityMode
stringAlphaMode
stringDepthTestMode
stringDepthWriteMode
stringVisibilityMode
write

## Methods of EggTransform:

EggTransform (Constructor)
addMatrix3
addMatrix4
addRotate2d
addRotate3d
addRotx
addRoty
addRotz
addScale2d
addScale3d
addTranslate2d
addTranslate3d
addUniformScale
clearTransform
getComponentMat3
getComponentMat4
getComponentNumber
getComponentType
getComponentVec2
getComponentVec3
getNumComponents
getTransform2d
getTransform3d
hasTransform
hasTransform2d
hasTransform3d
operator =
setTransform2d
setTransform3d
transformIsIdentity
write

## Constants in EggGroup:

GTInvalid | (GroupType)
GTGroup | (GroupType)
GTInstance | (GroupType)
GTJoint | (GroupType)
DTNone | (DartType)
DTSync | (DartType)
DTNosync | (DartType)
DTDefault | (DartType)
DCUnspecified | (DCSType)
DCNone | (DCSType)
DCLocal | (DCSType)
DCNet | (DCSType)
DCNoTouch | (DCSType)
DCDefault | (DCSType)
BTNone | (BillboardType)
BTAxis | (BillboardType)
BTPointCameraRelative | (BillboardType)
BTPointWorldRelative | (BillboardType)
CSTNone | (CollisionSolidType)
CSTPlane | (CollisionSolidType)
CSTPolygon | (CollisionSolidType)
CSTPolyset | (CollisionSolidType)
CSTSphere | (CollisionSolidType)
CSTTube | (CollisionSolidType)
CSTInvSphere | (CollisionSolidType)
CSTFloorMesh | (CollisionSolidType)
CFNone | (CollideFlags)
CFDescend | (CollideFlags)
CFEvent | (CollideFlags)
CFKeep | (CollideFlags)
CFSolid | (CollideFlags)
CFCenter | (CollideFlags)
CFTurnstile | (CollideFlags)
CFLevel | (CollideFlags)
CFIntangible | (CollideFlags)
BMUnspecified | (BlendMode)
BMNone | (BlendMode)
BMAdd | (BlendMode)
BMSubtract | (BlendMode)
BMInvSubtract | (BlendMode)
BMMin | (BlendMode)
BMMax | (BlendMode)
BOUnspecified | (BlendOperand)
BOZero | (BlendOperand)
BOOne | (BlendOperand)
BOIncomingColor | (BlendOperand)
BOOneMinusIncomingColor | (BlendOperand)
BOFbufferColor | (BlendOperand)
BOOneMinusFbufferColor | (BlendOperand)
BOIncomingAlpha | (BlendOperand)
BOOneMinusIncomingAlpha | (BlendOperand)
BOFbufferAlpha | (BlendOperand)
BOOneMinusFbufferAlpha | (BlendOperand)
BOConstantColor | (BlendOperand)
BOOneMinusConstantColor | (BlendOperand)
BOConstantAlpha | (BlendOperand)
BOOneMinusConstantAlpha | (BlendOperand)
BOIncomingColorSaturate | (BlendOperand)
BOColorScale | (BlendOperand)
BOOneMinusColorScale | (BlendOperand)
BOAlphaScale | (BlendOperand)
BOOneMinusAlphaScale | (BlendOperand)

## Constants in EggGroupNode:

TPolygon | (TriangulateFlags)
TConvex | (TriangulateFlags)
TComposite | (TriangulateFlags)
TRecurse | (TriangulateFlags)
TFlatShaded | (TriangulateFlags)

## Constants in EggRenderMode:

AMUnspecified | (AlphaMode)
AMOff | (AlphaMode)
AMOn | (AlphaMode)
AMBlend | (AlphaMode)
AMBlendNoOcclude | (AlphaMode)
AMMs | (AlphaMode)
AMMsMask | (AlphaMode)
AMBinary | (AlphaMode)
AMDual | (AlphaMode)
DWMUnspecified | (DepthWriteMode)
DWMOff | (DepthWriteMode)
DWMOn | (DepthWriteMode)
DTMUnspecified | (DepthTestMode)
DTMOff | (DepthTestMode)
DTMOn | (DepthTestMode)
VMUnspecified | (VisibilityMode)
VMHidden | (VisibilityMode)
VMNormal | (VisibilityMode)

## Constants in EggTransform:

CTInvalid | (ComponentType)
CTTranslate2d | (ComponentType)
CTTranslate3d | (ComponentType)
CTRotate2d | (ComponentType)
CTRotx | (ComponentType)
CTRoty | (ComponentType)
CTRotz | (ComponentType)
CTRotate3d | (ComponentType)
CTScale2d | (ComponentType)
CTScale3d | (ComponentType)
CTUniformScale | (ComponentType)
CTMatrix3 | (ComponentType)
CTMatrix4 | (ComponentType)

EggGroup EggGroup::EggGroup(string const &name = ("")); Description:

addGroupRef void EggGroup::add_group_ref(EggGroup *group); NDEBUG Description: Adds a new <Ref> entry to the group. This declares an internal reference to another node, and is used to implement scene-graph instancing; it is only valid if the group_type is GT_instance.

addObjectType void EggGroup::add_object_type(string const &object_type); Description:

clearBillboardCenter void EggGroup::clear_billboard_center(void); Description:

clearBlendColor void EggGroup::clear_blend_color(void); Description: Removes the blend color specification.

clearCollideMask void EggGroup::clear_collide_mask(void); Description:

clearCollisionName void EggGroup::clear_collision_name(void); Description:

clearDefaultPose void EggGroup::clear_default_pose(void); Description: Removes the initial pose transform. See set_default_pose().

clearFromCollideMask void EggGroup::clear_from_collide_mask(void); Description:

clearGroupRefs void EggGroup::clear_group_refs(void); Description: Removes all of the <Ref> entries within this group. See add_group_ref().

clearIndexedFlag void EggGroup::clear_indexed_flag(void); Description:

clearIntoCollideMask void EggGroup::clear_into_collide_mask(void); Description:

clearLod void EggGroup::clear_lod(void); Description:

clearObjectTypes void EggGroup::clear_object_types(void); Description:

clearTag void EggGroup::clear_tag(string const &key); Description: Removes the value defined for this key on this particular node. After a call to clear_tag(), has_tag() will return false for the indicated key.

determineAlphaMode virtual EggRenderMode *EggGroup::determine_alpha_mode(void); Description: Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this group that has an alpha_mode other than AM_unspecified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineBin virtual EggRenderMode *EggGroup::determine_bin(void); Description: Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this group that has a bin specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineDecal virtual bool EggGroup::determine_decal(void); Description: Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "decal" flag set. Returns the value of the decal flag if it is found, or false if it is not. In other words, returns true if the "decal" flag is in effect for the indicated node, false otherwise.

determineDepthTestMode virtual EggRenderMode *EggGroup::determine_depth_test_mode(void); Description: Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this group that has a depth_test_mode other than DTM_unspecified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineDepthWriteMode virtual EggRenderMode *EggGroup::determine_depth_write_mode(void); Description: Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this group that has a depth_write_mode other than DWM_unspecified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineDrawOrder virtual EggRenderMode *EggGroup::determine_draw_order(void); Description: Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this group that has a draw_order specified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineIndexed virtual bool EggGroup::determine_indexed(void); Description: Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "indexed" scalar set. Returns the value of the indexed scalar if it is found, or false if it is not. In other words, returns true if the "indexed" flag is in effect for the indicated node, false otherwise.

determineVisibilityMode virtual EggRenderMode *EggGroup::determine_visibility_mode(void); Description: Walks back up the hierarchy, looking for an EggGroup or EggPrimitive or some such object at this level or above this group that has a visibility_mode other than VM_unspecified. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

getBillboardCenter LPoint3d const &EggGroup::get_billboard_center(void) const; Description:

getBillboardType EggGroup::BillboardType EggGroup::get_billboard_type(void) const; Description:

getBlendColor LVecBase4f const &EggGroup::get_blend_color(void) const; Description: Returns the blend color if one has been specified, or (0, 0, 0, 0) if one has not.

getBlendMode EggGroup::BlendMode EggGroup::get_blend_mode(void) const; Description:

getBlendOperandA EggGroup::BlendOperand EggGroup::get_blend_operand_a(void) const; Description:

getBlendOperandB EggGroup::BlendOperand EggGroup::get_blend_operand_b(void) const; Description:

getClassType static TypeHandle EggGroup::get_class_type(void); Undocumented function.

getCollideFlags EggGroup::CollideFlags EggGroup::get_collide_flags(void) const; Description:

getCollideMask BitMask< unsigned int, 32 > EggGroup::get_collide_mask(void) const; Description:

getCollisionName string const &EggGroup::get_collision_name(void) const; Description:

getCsType EggGroup::CollisionSolidType EggGroup::get_cs_type(void) const; Description:

getDartType EggGroup::DartType EggGroup::get_dart_type(void) const; Description:

getDcsType EggGroup::DCSType EggGroup::get_dcs_type(void) const; Description:

getDecalFlag bool EggGroup::get_decal_flag(void) const; Description:

getDefaultPose EggTransform const &EggGroup::get_default_pose(void) const; Description: Returns a read-only accessor to the initial pose transform. This is the <DefaultPose> entry for a Joint, and defines only the initial transform pose for the unanimated joint; it has nothing to do with the group's <Transform> entry, which defines the (eventual) space of the group's vertices.

getDirectFlag bool EggGroup::get_direct_flag(void) const; Description:

getFromCollideMask BitMask< unsigned int, 32 > EggGroup::get_from_collide_mask(void) const; Description:

getGroupRef EggGroup *EggGroup::get_group_ref(int n) const; Description: Returns the nth <Ref> entry within this group. See add_group_ref().

getGroupType EggGroup::GroupType EggGroup::get_group_type(void) const; Description:

getIndexedFlag bool EggGroup::get_indexed_flag(void) const; Description:

getIntoCollideMask BitMask< unsigned int, 32 > EggGroup::get_into_collide_mask(void) const; Description:

getLod EggSwitchCondition const &EggGroup::get_lod(void) const; Description:

getModelFlag bool EggGroup::get_model_flag(void) const; Description:

getNofogFlag bool EggGroup::get_nofog_flag(void) const; Description:

getNumGroupRefs int EggGroup::get_num_group_refs(void) const; Description: Returns the number of <Ref> entries within this group. See add_group_ref().

getNumObjectTypes int EggGroup::get_num_object_types(void) const; Description:

getObjectType string EggGroup::get_object_type(int index) const; Description:

getPolylightFlag bool EggGroup::get_polylight_flag(void) const; Description:

getPortalFlag bool EggGroup::get_portal_flag(void) const; Description:

getSwitchFlag bool EggGroup::get_switch_flag(void) const; Description:

getSwitchFps double EggGroup::get_switch_fps(void) const; Description:

getTag string EggGroup::get_tag(string const &key) const; Description: Retrieves the user-defined value that was previously set on this node for the particular key, if any. If no value has been previously set, returns the empty string.

getTexlistFlag bool EggGroup::get_texlist_flag(void) const; Description:

getVertexMembership double EggGroup::get_vertex_membership(EggVertex const *vert) const; Description: Returns the amount of membership of the indicated vertex in this group. If the vertex is not reffed by the group, returns 0.

hasBillboardCenter bool EggGroup::has_billboard_center(void) const; Description:

hasBlendColor bool EggGroup::has_blend_color(void) const; Description: Returns true if the blend color has been specified, false otherwise.

hasCollideMask bool EggGroup::has_collide_mask(void) const; Description:

hasCollisionName bool EggGroup::has_collision_name(void) const; Description:

hasDcsType bool EggGroup::has_dcs_type(void) const; Description: Returns true if the specified DCS type is not DC_none and not DC_unspecified.

hasFromCollideMask bool EggGroup::has_from_collide_mask(void) const; Description:

hasIndexedFlag bool EggGroup::has_indexed_flag(void) const; Description:

hasIntoCollideMask bool EggGroup::has_into_collide_mask(void) const; Description:

hasLod bool EggGroup::has_lod(void) const; Description:

hasObjectType bool EggGroup::has_object_type(string const &object_type) const; Description: Returns true if the indicated object type has been added to the group, or false otherwise.

hasTag bool EggGroup::has_tag(string const &key) const; Description: Returns true if a value has been defined on this node for the particular key (even if that value is the empty string), or false if no value has been set.

isInstanceType bool EggGroup::is_instance_type(void) const; Description: Returns true if this group is an instance type node; i.e. it begins the root of a local coordinate space. This is not related to instancing (multiple copies of a node in a scene graph). This also includes the case of the node including a billboard flag without an explicit center, which implicitly makes the node behave like an instance.

isJoint virtual bool EggGroup::is_joint(void) const; Description: Returns true if this particular node represents a <Joint> entry or not. This is a handy thing to know since Joints are sorted to the end of their sibling list when writing an egg file. See EggGroupNode::write().

modifyDefaultPose EggTransform &EggGroup::modify_default_pose(void); Description: Returns a writable accessor to the initial pose transform. This is the <DefaultPose> entry for a Joint, and defines only the initial transform pose for the unanimated joint; it has nothing to do with the group's <Transform> entry, which defines the (eventual) space of the group's vertices.

operator = EggGroup &EggGroup::operator =(EggGroup const &copy); Description:

refVertex void EggGroup::ref_vertex(EggVertex *vert, double membership = (1)); Description: Adds the vertex to the set of those referenced by the group, at the indicated membership level. If the vertex is already being referenced, increases the membership amount by the indicated amount.

removeGroupRef void EggGroup::remove_group_ref(int n); Description: Removes the nth <Ref> entry within this group. See add_group_ref().

removeObjectType bool EggGroup::remove_object_type(string const &object_type); Description: Removes the first instance of the indicated object type from the group if it is present. Returns true if the object type was found and removed, false otherwise.

setBillboardCenter void EggGroup::set_billboard_center(LPoint3d const &billboard_center); Description: Sets the point around which the billboard will rotate, if this node contains a billboard specification. If a billboard type is given but no billboard_center is specified, then the group node is treated as an <Instance>, and the billboard rotates around the origin. If, however, a billboard_center is specified, then the group node is *not* treated as an <Instance>, and the billboard rotates around the specified point. The point is in the same coordinate system as the vertices of this node: usually global, but possibly local if there is an <Instance> somewhere above. Specifically, this is the coordinate system defined by get_vertex_frame().

setBillboardType void EggGroup::set_billboard_type(EggGroup::BillboardType type); Description:

setBlendColor void EggGroup::set_blend_color(LVecBase4f const &blend_color); Description:

setBlendMode void EggGroup::set_blend_mode(EggGroup::BlendMode blend_mode); Description:

setBlendOperandA void EggGroup::set_blend_operand_a(EggGroup::BlendOperand blend_operand_a); Description:

setBlendOperandB void EggGroup::set_blend_operand_b(EggGroup::BlendOperand blend_operand_b); Description:

setCollideFlags void EggGroup::set_collide_flags(int flags); Description:

setCollideMask void EggGroup::set_collide_mask(BitMask< unsigned int, 32 > mask); Description:

setCollisionName void EggGroup::set_collision_name(string const &collision_name); Description:

setCsType void EggGroup::set_cs_type(EggGroup::CollisionSolidType type); Description:

setDartType void EggGroup::set_dart_type(EggGroup::DartType type); Description:

setDcsType void EggGroup::set_dcs_type(EggGroup::DCSType type); Description:

setDecalFlag void EggGroup::set_decal_flag(bool flag); Description:

setDefaultPose void EggGroup::set_default_pose(EggTransform const &transform); Description: Replaces the initial pose transform. This is the <DefaultPose> entry for a Joint, and defines only the initial transform pose for the unanimated joint; it has nothing to do with the group's <Transform> entry, which defines the (eventual) space of the group's vertices.

setDirectFlag void EggGroup::set_direct_flag(bool flag); Description:

setFromCollideMask void EggGroup::set_from_collide_mask(BitMask< unsigned int, 32 > mask); Description:

setGroupType void EggGroup::set_group_type(EggGroup::GroupType type); Description:

setIndexedFlag void EggGroup::set_indexed_flag(bool flag); Description: If this flag is true, geometry at this node and below will be generated as indexed geometry.

setIntoCollideMask void EggGroup::set_into_collide_mask(BitMask< unsigned int, 32 > mask); Description:

setLod void EggGroup::set_lod(EggSwitchCondition const &lod); Description:

setModelFlag void EggGroup::set_model_flag(bool flag); Description:

setNofogFlag void EggGroup::set_nofog_flag(bool flag); Description:

setPolylightFlag void EggGroup::set_polylight_flag(bool flag); Description:

setPortalFlag void EggGroup::set_portal_flag(bool flag); Description:

setSwitchFlag void EggGroup::set_switch_flag(bool flag); Description:

setSwitchFps void EggGroup::set_switch_fps(double fps); Description:

setTag void EggGroup::set_tag(string const &key, string const &value); Description: Associates a user-defined value with a user-defined key which is stored on the node. This value has no meaning to Panda; but it is stored indefinitely on the node until it is requested again. This value will be copied to the PandaNode that is created for this particular EggGroup if the egg file is loaded as a scene. Each unique key stores a different string value. There is no effective limit on the number of different keys that may be stored or on the length of any one key's value.

setTexlistFlag void EggGroup::set_texlist_flag(bool flag); Description:

setVertexMembership void EggGroup::set_vertex_membership(EggVertex *vert, double membership); Description: Explicitly sets the net membership of the indicated vertex in this group to the given value.

stealVrefs void EggGroup::steal_vrefs(EggGroup *other); Description: Moves all of the vertex references from the indicated other group into this one. If a given vertex was previously shared by both groups, the relative memberships will be summed.

stringBillboardType static EggGroup::BillboardType EggGroup::string_billboard_type(string const &strval); Description: Returns the BillboardType value associated with the given string representation, or BT_none if the string does not match any known BillboardType value.

stringBlendMode static EggGroup::BlendMode EggGroup::string_blend_mode(string const &strval); Description: Returns the BlendMode value associated with the given string representation, or BM_none if the string does not match any known BlendMode.

stringBlendOperand static EggGroup::BlendOperand EggGroup::string_blend_operand(string const &strval); Description: Returns the BlendOperand value associated with the given string representation, or BO_none if the string does not match any known BlendOperand.

stringCollideFlags static EggGroup::CollideFlags EggGroup::string_collide_flags(string const &strval); Description: Returns the CollideFlags value associated with the given string representation, or CF_none if the string does not match any known CollideFlags value. This only recognizes a single keyword; it does not attempt to parse a string of keywords.

stringCsType static EggGroup::CollisionSolidType EggGroup::string_cs_type(string const &strval); Description: Returns the CollisionSolidType value associated with the given string representation, or CST_none if the string does not match any known CollisionSolidType value.

stringDartType static EggGroup::DartType EggGroup::string_dart_type(string const &strval); Description: Returns the DartType value associated with the given string representation, or DT_none if the string does not match any known DartType value.

stringDcsType static EggGroup::DCSType EggGroup::string_dcs_type(string const &strval); Description: Returns the DCSType value associated with the given string representation, or DC_unspecified if the string does not match any known DCSType value.

stringGroupType static EggGroup::GroupType EggGroup::string_group_type(string const &strval); Description: Returns the GroupType value associated with the given string representation, or GT_invalid if the string does not match any known GroupType value.

testVrefIntegrity void EggGroup::test_vref_integrity(void) const; Description: Verifies that each vertex in the group exists and that it knows it is referenced by the group.

unrefAllVertices void EggGroup::unref_all_vertices(void); Description: Removes all vertices from the reference list.

unrefVertex void EggGroup::unref_vertex(EggVertex *vert); Description: Removes the vertex from the set of those referenced by the group. Does nothing if the vertex is not already reffed.

write virtual void EggGroup::write(ostream &out, int indent_level) const; Description: Writes the group and all of its children to the indicated output stream in Egg format.

writeBillboardFlags void EggGroup::write_billboard_flags(ostream &out, int indent_level) const; Description: Writes just the <Billboard> entry and related fields to the indicated ostream.

writeCollideFlags void EggGroup::write_collide_flags(ostream &out, int indent_level) const; Description: Writes just the <Collide> entry and related fields to the indicated ostream.

writeDecalFlags void EggGroup::write_decal_flags(ostream &out, int indent_level) const; Description: Writes the flags related to decaling, if any.

writeModelFlags void EggGroup::write_model_flags(ostream &out, int indent_level) const; Description: Writes the <Model> flag and related flags to the indicated ostream.

writeObjectTypes void EggGroup::write_object_types(ostream &out, int indent_level) const; Description: Writes just the <ObjectTypes> entries, if any, to the indicated ostream.

writeRenderMode void EggGroup::write_render_mode(ostream &out, int indent_level) const; Description: Writes the flags inherited from EggRenderMode and similar flags that control obscure render effects.

writeSwitchFlags void EggGroup::write_switch_flags(ostream &out, int indent_level) const; Description: Writes the <Switch> flag and related flags to the indicated ostream.

writeTags void EggGroup::write_tags(ostream &out, int indent_level) const; Description: Writes just the <Tag> entries, if any, to the indicated ostream.

EggGroupNode EggGroupNode::EggGroupNode(string const &name = ("")); Description:

addChild EggNode *EggGroupNode::add_child(EggNode *node); Description: Adds the indicated child to the group and returns it. If the child node is already a child of some other node, removes it first.

applyFirstAttribute void EggGroupNode::apply_first_attribute(bool recurse); Description: Sets the first vertex of the triangle (or each component) to the primitive normal and/or color, if the primitive is flat-shaded. This reflects the DirectX convention of storing flat-shaded properties on the first vertex, although it is not usually a convention in Egg. This may create redundant vertices in the vertex pool, so it may be a good idea to follow this up with remove_unused_vertices().

applyLastAttribute void EggGroupNode::apply_last_attribute(bool recurse); Description: Sets the last vertex of the triangle (or each component) to the primitive normal and/or color, if the primitive is flat-shaded. This reflects the OpenGL convention of storing flat-shaded properties on the last vertex, although it is not usually a convention in Egg. This may create redundant vertices in the vertex pool, so it may be a good idea to follow this up with remove_unused_vertices().

clear void EggGroupNode::clear(void); Description:

clearConnectedShading void EggGroupNode::clear_connected_shading(void); Description: Resets the connected_shading information on all primitives at this node and below, so that it may be accurately rederived by the next call to get_connected_shading(). It may be a good idea to call remove_unused_vertices() as well, to establish the correct connectivity between common vertices.

empty bool EggGroupNode::empty(void) const; Description:

findChild EggNode *EggGroupNode::find_child(string const &name) const; Description: Returns the child of this node whose name is the indicated string, or NULL if there is no child of this node by that name. Does not search recursively.

forceFilenames void EggGroupNode::force_filenames(Filename const &directory); Description: Similar to resolve_filenames, but each non-absolute filename encountered is arbitrarily taken to be in the indicated directory, whether or not the so-named filename exists.

getClassType static TypeHandle EggGroupNode::get_class_type(void); Undocumented function.

getConnectedShading void EggGroupNode::get_connected_shading(void); Description: Queries the connected_shading information on all primitives at this node and below, to ensure that it has been completely filled in before we start mucking around with vertices.

getFirstChild EggNode *EggGroupNode::get_first_child(void); This is an alternate way to traverse the list of children. It is mainly provided for scripting code, which can't use the iterators defined above (they don't export through interrogate very well). These are, of course, non-thread-safe. Description: Returns the first child in the group's list of children, or NULL if the list of children is empty. Can be used with get_next_child() to return the complete list of children without using the iterator class; however, this is non-thread-safe, and so is not recommended except for languages other than C++ which cannot use the iterators.

getNextChild EggNode *EggGroupNode::get_next_child(void); This is an alternate way to traverse the list of children. It is mainly provided for scripting code, which can't use the iterators defined above (they don't export through interrogate very well). These are, of course, non-thread-safe. Description: Returns the next child in the group's list of children since the last call to get_first_child() or get_next_child(), or NULL if the last child has been returned. Can be used with get_first_child() to return the complete list of children without using the iterator class; however, this is non-thread-safe, and so is not recommended except for languages other than C++ which cannot use the iterators. It is an error to call this without previously calling get_first_child().

hasAbsolutePathnames bool EggGroupNode::has_absolute_pathnames(void) const; Description: Returns true if any nodes at this level and below include a reference to a file via an absolute pathname, or false if all references are relative.

hasNormals virtual bool EggGroupNode::has_normals(void) const; Description: Returns true if any of the primitives (e.g. polygons) defined within this group or below have either face or vertex normals defined, false otherwise.

hasPrimitives virtual bool EggGroupNode::has_primitives(void) const; Description: Returns true if there are any primitives (e.g. polygons) defined within this group or below, false otherwise.

isRight static bool EggGroupNode::is_right(LVector2d const &v1, LVector2d const &v2); Description: Returns true if the 2-d v1 is to the right of v2.

jointHasPrimitives virtual bool EggGroupNode::joint_has_primitives(void) const; Description: Returns true if there are any primitives (e.g. polygons) defined within this group or below, but the search does not include nested joints.

meshTriangles void EggGroupNode::mesh_triangles(int flags); Description: Combine triangles together into triangle strips, at this group and below.

operator = EggGroupNode &EggGroupNode::operator =(EggGroupNode const &copy); Description:

postApplyFlatAttribute void EggGroupNode::post_apply_flat_attribute(bool recurse); Description: Intended as a followup to apply_last_attribute(), this also sets an attribute on the first vertices of the primitive, if they don't already have an attribute set, just so they end up with *something*.

recomputePolygonNormals void EggGroupNode::recompute_polygon_normals(CoordinateSystem cs = (CS_default)); Description: Recomputes all the polygon normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. Normals are removed from the vertices and defined only on polygons, giving the geometry a faceted appearance. This function also removes degenerate polygons that do not have enough vertices to define a normal. It does not affect normals for other kinds of primitives like Nurbs or Points. This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the normals removed. Thus, it is a good idea to call remove_unused_vertices() after calling this.

recomputeTangentBinormal bool EggGroupNode::recompute_tangent_binormal(GlobPattern const &uv_name); Description: This function recomputes the tangent and binormal for the named texture coordinate set for all vertices at this level and below. Use the empty string for the default texture coordinate set. It is necessary for each vertex to already have a normal (or at least a polygon normal), as well as a texture coordinate in the named texture coordinate set, before calling this function. You might precede this with recompute_vertex_normals() to ensure that the normals exist. Like recompute_vertex_normals(), this function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the new tangents and binormals computed. Thus, it is a good idea to call remove_unused_vertices() after calling this. Description: This function recomputes the tangent and binormal for the named texture coordinate sets. Returns true if anything was done.

recomputeTangentBinormalAuto bool EggGroupNode::recompute_tangent_binormal_auto(void); Description: This function recomputes the tangent and binormal for any texture coordinate set that affects a normal map. Returns true if anything was done.

recomputeVertexNormals void EggGroupNode::recompute_vertex_normals(double threshold, CoordinateSystem cs = (CS_default)); Description: Recomputes all the vertex normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. A shared edge between two polygons (even in different groups) is considered smooth if the angle between the two edges is less than threshold degrees. This function also removes degenerate polygons that do not have enough vertices to define a normal. It does not affect normals for other kinds of primitives like Nurbs or Points. This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the correct normals. Thus, it is a good idea to call remove_unused_vertices() after calling this.

removeChild PointerTo< EggNode > EggGroupNode::remove_child(EggNode *node); Description: Removes the indicated child node from the group and returns it. If the child was not already in the group, does nothing and returns NULL.

removeInvalidPrimitives int EggGroupNode::remove_invalid_primitives(bool recurse); Description: Removes primitives at this level and below which appear to be degenerate; e.g. polygons with fewer than 3 vertices, etc. Returns the number of primitives removed.

removeUnusedVertices int EggGroupNode::remove_unused_vertices(bool recurse); Description: Removes all vertices from VertexPools within this group or below that are not referenced by at least one primitive. Also collapses together equivalent vertices, and renumbers all vertices after the operation so their indices are consecutive, beginning at zero. Returns the total number of vertices removed. Note that this operates on the VertexPools within this group level, without respect to primitives that reference these vertices (unlike other functions like strip_normals()). It is therefore most useful to call this on the EggData root, rather than on a subgroup within the hierarchy, since a VertexPool may appear anywhere in the hierarchy.

renameNodes int EggGroupNode::rename_nodes(vector< string > strip_prefix, bool recurse); Description: Rename by stripping out the prefix

resolveFilenames void EggGroupNode::resolve_filenames(DSearchPath const &searchpath); Description: Walks the tree and attempts to resolve any filenames encountered. This looks up filenames along the specified search path; it does not automatically search the model_path for missing files.

reverseVertexOrdering void EggGroupNode::reverse_vertex_ordering(void); Description: Reverses the vertex ordering of all polygons defined at this node and below. Does not change the surface normals, if any.

size unsigned int EggGroupNode::size(void) const; Description:

stealChildren void EggGroupNode::steal_children(EggGroupNode &other); Description: Moves all the children from the other node to this one. This is especially useful because the group node copy assignment operator does not copy children.

stripNormals void EggGroupNode::strip_normals(void); Description: Removes all normals from primitives, and the vertices they reference, at this node and below. This function does not remove or adjust vertices in the vertex pool; it only adds new vertices with the normal removed. Thus, it is a good idea to call remove_unused_vertices() after calling this.

triangulatePolygons int EggGroupNode::triangulate_polygons(int flags); Description: Replace all higher-order polygons at this point in the scene graph and below with triangles. Returns the total number of new triangles produced, less degenerate polygons removed. If flags contains T_polygon and T_convex, both concave and convex polygons will be subdivided into triangles; with only T_polygon, only concave polygons will be subdivided, and convex polygons will be largely unchanged.

unifyAttributes void EggGroupNode::unify_attributes(bool use_connected_shading, bool allow_per_primitive, bool recurse); Description: Applies per-vertex normal and color to all vertices, if they are in fact per-vertex (and different for each vertex), or moves them to the primitive if they are all the same. After this call, either the primitive will have normals or its vertices will, but not both. Ditto for colors. If use_connected_shading is true, each polygon is considered in conjunction with all connected polygons; otherwise, each polygon is considered individually. If allow_per_primitive is false, S_per_face or S_overall will treated like S_per_vertex: normals and colors will always be assigned to the vertices. In this case, there will never be per-primitive colors or normals after this call returns. On the other hand, if allow_per_primitive is true, then S_per_face means that normals and colors should be assigned to the primitives, and removed from the vertices, as described above. This may create redundant vertices in the vertex pool, so it may be a good idea to follow this up with remove_unused_vertices().

applyTexmats void EggNode::apply_texmats(void); Description: Applies the texture matrices to the UV's of the vertices that reference them, and then removes the texture matrices from the textures themselves.

determineAlphaMode virtual EggRenderMode *EggNode::determine_alpha_mode(void); Description: 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineBin virtual EggRenderMode *EggNode::determine_bin(void); Description: 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineDecal virtual bool EggNode::determine_decal(void); Description: Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "decal" flag set. Returns the value of the decal flag if it is found, or false if it is not. In other words, returns true if the "decal" flag is in effect for the indicated node, false otherwise.

determineDepthTestMode virtual EggRenderMode *EggNode::determine_depth_test_mode(void); Description: 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineDepthWriteMode virtual EggRenderMode *EggNode::determine_depth_write_mode(void); Description: 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineDrawOrder virtual EggRenderMode *EggNode::determine_draw_order(void); Description: 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

determineIndexed virtual bool EggNode::determine_indexed(void); Description: Walks back up the hierarchy, looking for an EggGroup at this level or above that has the "indexed" scalar set. Returns the value of the indexed scalar if it is found, or false if it is not. In other words, returns true if the "indexed" flag is in effect for the indicated node, false otherwise.

determineVisibilityMode virtual EggRenderMode *EggNode::determine_visibility_mode(void); Description: 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. Returns a valid EggRenderMode pointer if one is found, or NULL otherwise.

flattenTransforms void EggNode::flatten_transforms(void); Description: Removes any transform and instance records from this node in the scene graph and below. If an instance node is encountered, removes the instance and applies the transform to its vertices, duplicating vertices if necessary. Since this function may result in duplicated vertices, it may be a good idea to call remove_unused_vertices() after calling this.

getClassType static TypeHandle EggNode::get_class_type(void); Undocumented function.

getDepth int EggNode::get_depth(void) const; Description: Returns the number of nodes above this node in the egg hierarchy.

getNodeFrame LMatrix4d const &EggNode::get_node_frame(void) const; Description: Returns the coordinate frame of the node itself. This is simply the net product of all transformations up to the root.

getNodeFrameInv LMatrix4d const &EggNode::get_node_frame_inv(void) const; Description: Returns the inverse of the matrix returned by get_node_frame(). See get_node_frame().

getNodeFrameInvPtr LMatrix4d const *EggNode::get_node_frame_inv_ptr(void) const; Description: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame_inv() matrix.

getNodeFramePtr LMatrix4d const *EggNode::get_node_frame_ptr(void) const; Description: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_frame() matrix.

getNodeToVertex LMatrix4d const &EggNode::get_node_to_vertex(void) const; Description: 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. This is the same thing as: get_node_frame() * get_vertex_frame_inv()

getNodeToVertexPtr LMatrix4d const *EggNode::get_node_to_vertex_ptr(void) const; Description: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_node_to_vertex() matrix.

getParent EggGroupNode *EggNode::get_parent(void) const; Description:

getVertexFrame LMatrix4d const &EggNode::get_vertex_frame(void) const; Description: Returns the coordinate frame of the vertices referenced by primitives at or under this node. This is not the same as get_node_frame(). Generally, vertices in an egg file are stored in the global coordinate space, regardless of the transforms defined at each node. Thus, get_vertex_frame() will usually return the identity transform (global coordinate space). However, primitives under an <Instance> entry reference their vertices in the coordinate system under effect at the time of the <Instance>. Thus, nodes under an <Instance> entry may return this non-identity matrix. Specifically, this may return a non-identity matrix only if is_local_coord() is true.

getVertexFrameInv LMatrix4d const &EggNode::get_vertex_frame_inv(void) const; Description: Returns the inverse of the matrix returned by get_vertex_frame(). See get_vertex_frame().

getVertexFrameInvPtr LMatrix4d const *EggNode::get_vertex_frame_inv_ptr(void) const; Description: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame_inv() matrix.

getVertexFramePtr LMatrix4d const *EggNode::get_vertex_frame_ptr(void) const; Description: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_frame() matrix.

getVertexToNode LMatrix4d const &EggNode::get_vertex_to_node(void) const; Description: Returns the transformation matrix suitable for converting the vertices as read from the egg file into the coordinate space of the node. This is the same thing as: get_vertex_frame() * get_node_frame_inv()

getVertexToNodePtr LMatrix4d const *EggNode::get_vertex_to_node_ptr(void) const; Description: Returns either a NULL pointer or a unique pointer shared by nodes with the same get_vertex_to_node() matrix.

isAnimMatrix virtual bool EggNode::is_anim_matrix(void) const; Description: Returns true if this node represents a table of animation transformation data, false otherwise.

isJoint virtual bool EggNode::is_joint(void) const; Description: Returns true if this particular node represents a <Joint> entry or not. This is a handy thing to know since Joints are sorted to the end of their sibling list when writing an egg file. See EggGroupNode::write().

isLocalCoord bool EggNode::is_local_coord(void) const; Description: Returns true if this node's vertices are not in the global coordinate space. This will be the case if there was an <Instance> node under a transform at or above this node.

isUnderInstance bool EggNode::is_under_instance(void) const; Description: Returns true if there is an <Instance> node somewhere in the egg tree at or above this node, false otherwise.

isUnderTransform bool EggNode::is_under_transform(void) const; Description: Returns true if there is a <Transform> entry somewhere in the egg tree at or above this node, false otherwise.

operator = EggNode &EggNode::operator =(EggNode const &copy); Description:

parseEgg bool EggNode::parse_egg(string const &egg_syntax); Description: Parses the egg syntax given in the indicate string as if it had been read from the egg file within this object's definition. Updates the object accordingly. Returns true if successful, false if there was some parse error or if the object does not support this functionality.

renameNode int EggNode::rename_node(vector< string > strip_prefix); Description: Rename by stripping out the prefix

testUnderIntegrity void EggNode::test_under_integrity(void) const; Description: Recursively checks the integrity of the _under_flags, _parent, and _depth members of this node and all of its ancestors.

transform void EggNode::transform(LMatrix4d const &mat); Description: Applies the indicated transformation to the node and all of its descendants.

transformVerticesOnly void EggNode::transform_vertices_only(LMatrix4d const &mat); Description: Applies the indicated transformation only to vertices that appear in global space within vertex pools at this node and below. Joints and other transforms are not affected, nor are local vertices.

write virtual void EggNode::write(ostream &out, int indent_level) const = 0; Undocumented function.

EggNamedObject EggNamedObject::EggNamedObject(string const &name = ("")); Description:

getClassType static TypeHandle EggNamedObject::get_class_type(void); Undocumented function.

operator = EggNamedObject &EggNamedObject::operator =(EggNamedObject const &copy); Description:

output void EggNamedObject::output(ostream &out) const; Description:

EggObject EggObject::EggObject(void); Description:

clearUserData void EggObject::clear_user_data(void); Description: Removes *all* user data pointers from the node. Description: Removes the user data pointer of the indicated type.

getClassType static TypeHandle EggObject::get_class_type(void); Undocumented function.

getUserData EggUserData *EggObject::get_user_data(void) const; Description: Returns the user data pointer most recently stored on this object, or NULL if nothing was previously stored. Description: Returns the user data pointer of the indicated type, if it exists, or NULL if it does not.

hasUserData bool EggObject::has_user_data(void) const; Description: Returns true if a generic user data pointer has recently been set and not yet cleared, false otherwise. Description: Returns true if the user data pointer of the indicated type has been set, false otherwise.

operator = EggObject &EggObject::operator =(EggObject const &copy); Description:

setUserData void EggObject::set_user_data(EggUserData *user_data); Description: Sets the user data associated with this object. This may be any EggUserData-derived object. The egg library will do nothing with this pointer, except to hold its reference count and return the pointer on request. The EggObject maintains multiple different EggUserData pointers, one for each unique type (as reported by get_type()). If you know that only one type of EggUserData object will be added in your application, you may use the query functions that accept no parameters, but it is recommended that in general you pass in the type of your particular user data, to allow multiple applications to coexist in the same egg data. This pointer is also copied by the copy assignment operator and copy constructor.

getClassType static TypeHandle TypedReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: 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().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: 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.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: 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; plus, we don't have a virtual destructor anyway.) 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.

Namable Namable::Namable(string const &initial_name = ("")); Description:

clearName void Namable::clear_name(void); Description: Resets the Namable's name to empty.

getClassType static TypeHandle Namable::get_class_type(void); Undocumented function.

getName string const &Namable::get_name(void) const; Description:

hasName bool Namable::has_name(void) const; Description: Returns true if the Namable has a nonempty name set, false if the name is empty.

operator = Namable &Namable::operator =(Namable const &other); Description:

output void Namable::output(ostream &out) const; In the absence of any definition to the contrary, outputting a Namable will write out its name. Description: Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

setName void Namable::set_name(string const &name); Description:

EggRenderMode EggRenderMode::EggRenderMode(void); Description:

clearBin void EggRenderMode::clear_bin(void); Description: Removes the bin name that was set for this particular object. See set_bin().

clearDrawOrder void EggRenderMode::clear_draw_order(void); Description: Removes the draw-order flag from this particular object. See set_draw_order().

getAlphaMode EggRenderMode::AlphaMode EggRenderMode::get_alpha_mode(void) const; Description: Returns the alpha mode that was set, or AM_unspecified if nothing was set. See set_alpha_mode().

getBin string EggRenderMode::get_bin(void) const; Description: Returns the bin name that has been set for this particular object, if any. See set_bin().

getClassType static TypeHandle EggRenderMode::get_class_type(void); Undocumented function.

getDepthTestMode EggRenderMode::DepthTestMode EggRenderMode::get_depth_test_mode(void) const; Description: Returns the depth_test mode that was set, or DTM_unspecified if nothing was set. See set_depth_test_mode().

getDepthWriteMode EggRenderMode::DepthWriteMode EggRenderMode::get_depth_write_mode(void) const; Description: Returns the depth_write mode that was set, or DWM_unspecified if nothing was set. See set_depth_write_mode().

getDrawOrder int EggRenderMode::get_draw_order(void) const; Description: Returns the "draw-order" flag as set for this particular object. See set_draw_order().

getVisibilityMode EggRenderMode::VisibilityMode EggRenderMode::get_visibility_mode(void) const; Description: Returns the visibility mode that was set, or VM_unspecified if nothing was set. See set_visibility_mode().

hasBin bool EggRenderMode::has_bin(void) const; Description: Returns true if a bin name has been set for this particular object. See set_bin().

hasDrawOrder bool EggRenderMode::has_draw_order(void) const; Description: Returns true if the draw-order flag has been set for this particular object. See set_draw_order().

operator != bool EggRenderMode::operator !=(EggRenderMode const &other) const; Comparison operators are handy. Description:

operator < bool EggRenderMode::operator <(EggRenderMode const &other) const; Description:

operator = EggRenderMode &EggRenderMode::operator =(EggRenderMode const &copy); Description:

operator == bool EggRenderMode::operator ==(EggRenderMode const &other) const; Comparison operators are handy. Description:

setAlphaMode void EggRenderMode::set_alpha_mode(EggRenderMode::AlphaMode mode); Description: Specifies precisely how the transparency for this geometry should be achieved, or if it should be used. The default, AM_unspecified, is to use transparency if the geometry has a color whose alpha value is non-1, or if it has a four-channel texture applied; otherwise, AM_on forces transparency on, and AM_off forces it off. The other flavors of transparency are specific ways to turn on transparency, which may or may not be supported by a particular rendering backend.

setBin void EggRenderMode::set_bin(string const &bin); Description: Sets the "bin" string for this particular object. This names a particular bin in which the object should be rendered. The exact meaning of a bin is implementation defined, but generally a GeomBin matching each bin name must also be specifically added to the rendering engine (e.g. the CullTraverser) in use for this to work. See also set_draw_order().

setDepthTestMode void EggRenderMode::set_depth_test_mode(EggRenderMode::DepthTestMode mode); Description: Specifies whether this geometry should be tested against the depth buffer when it is drawn (assuming the rendering backend provides a depth buffer). Note that this is different, and independent from, the depth_write mode.

setDepthWriteMode void EggRenderMode::set_depth_write_mode(EggRenderMode::DepthWriteMode mode); Description: Specifies whether writes should be made to the depth buffer (assuming the rendering backend provides a depth buffer) when rendering this geometry.

setDrawOrder void EggRenderMode::set_draw_order(int order); Description: Sets the "draw-order" flag associated with this object. This specifies a particular order in which objects of this type should be drawn, within the specified bin. If a bin is not explicitly specified, "fixed" is used. See also set_bin().

setVisibilityMode void EggRenderMode::set_visibility_mode(EggRenderMode::VisibilityMode mode); Description: Specifies whether this geometry is to be considered normally visible, or hidden. If it is hidden, it is either not loaded into the scene graph at all, or loaded as a "stashed" node, according to the setting of egg-suppress-hidden.

stringAlphaMode static EggRenderMode::AlphaMode EggRenderMode::string_alpha_mode(string const &string); Description: Returns the AlphaMode value associated with the given string representation, or AM_unspecified if the string does not match any known AlphaMode value.

stringDepthTestMode static EggRenderMode::DepthTestMode EggRenderMode::string_depth_test_mode(string const &string); Description: Returns the DepthTestMode value associated with the given string representation, or DTM_unspecified if the string does not match any known DepthTestMode value.

stringDepthWriteMode static EggRenderMode::DepthWriteMode EggRenderMode::string_depth_write_mode(string const &string); Description: Returns the DepthWriteMode value associated with the given string representation, or DWM_unspecified if the string does not match any known DepthWriteMode value.

stringVisibilityMode static EggRenderMode::VisibilityMode EggRenderMode::string_visibility_mode(string const &string); Description: Returns the HiddenMode value associated with the given string representation, or VM_unspecified if the string does not match any known HiddenMode value.

write void EggRenderMode::write(ostream &out, int indent_level) const; Description: Writes the attributes to the indicated output stream in Egg format.

EggTransform EggTransform::EggTransform(void); Description:

addMatrix3 void EggTransform::add_matrix3(LMatrix3d const &mat); Description: Appends an arbitrary 3x3 matrix to the current transform.

addMatrix4 void EggTransform::add_matrix4(LMatrix4d const &mat); Description: Appends an arbitrary 4x4 matrix to the current transform.

addRotate2d void EggTransform::add_rotate2d(double angle); Description: Appends a 2-d rotation to the current transform. The rotation angle is specified in degrees counterclockwise about the origin.

addRotate3d void EggTransform::add_rotate3d(double angle, LVector3d const &axis); Description: Appends a 3-d rotation about an arbitrary axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis. Description: Appends an arbitrary 3-d rotation to the current transform, expressed as a quaternion. This is converted to axis-angle notation for the egg file.

addRotx void EggTransform::add_rotx(double angle); Description: Appends a rotation about the X axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis.

addRoty void EggTransform::add_roty(double angle); Description: Appends a rotation about the Y axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis.

addRotz void EggTransform::add_rotz(double angle); Description: Appends a rotation about the Z axis to the current transform. The rotation angle is specified in degrees counterclockwise about the axis.

addScale2d void EggTransform::add_scale2d(LVecBase2d const &scale); Description: Appends a possibly non-uniform scale to the current transform.

addScale3d void EggTransform::add_scale3d(LVecBase3d const &scale); Description: Appends a possibly non-uniform scale to the current transform.

addTranslate2d void EggTransform::add_translate2d(LVector2d const &translate); Description: Appends a 2-d translation operation to the current transform.

addTranslate3d void EggTransform::add_translate3d(LVector3d const &translate); Description: Appends a 3-d translation operation to the current transform.

addUniformScale void EggTransform::add_uniform_scale(double scale); Description: Appends a uniform scale to the current transform.

clearTransform void EggTransform::clear_transform(void); Description: Resets the transform to empty, identity.

getComponentMat3 LMatrix3d const &EggTransform::get_component_mat3(int n) const; Description: Returns the 3x3 matrix associated with the nth component. It is an error to call this if the component type is not CT_matrix3.

getComponentMat4 LMatrix4d const &EggTransform::get_component_mat4(int n) const; Description: Returns the 4x4 matrix associated with the nth component. It is an error to call this if the component type is not CT_matrix4.

getComponentNumber double EggTransform::get_component_number(int n) const; Description: Returns the solitary number associated with the nth component. In the case of a rotation, this is the angle in degrees to rotate; in the case of uniform scale, this is the amount of the scale. Other types do not use this property.

getComponentType EggTransform::ComponentType EggTransform::get_component_type(int n) const; Description: Returns the type of the nth component.

getComponentVec2 LVecBase2d const &EggTransform::get_component_vec2(int n) const; Description: Returns the 2-component vector associated with the nth component. This may be the translate vector, rotate axis, or non-uniform scale. It is an error to call this if the component type does not use a 2-d vector property.

getComponentVec3 LVecBase3d const &EggTransform::get_component_vec3(int n) const; Description: Returns the 3-component vector associated with the nth component. This may be the translate vector, rotate axis, or non-uniform scale. It is an error to call this if the component type does not use a 3-d vector property.

getNumComponents int EggTransform::get_num_components(void) const; Description: Returns the number of components that make up the transform.

getTransform2d LMatrix3d EggTransform::get_transform2d(void) const; Description: Returns the overall transform as a 3x3 matrix. It is an error to call this if has_transform3d() is true.

getTransform3d LMatrix4d const &EggTransform::get_transform3d(void) const; Description: Returns the overall transform as a 4x4 matrix. It is valid to call this even if has_transform2d() is true; in this case, the 3x3 transform will be expanded to a 4x4 matrix.

hasTransform bool EggTransform::has_transform(void) const; Description: Returns true if the transform is nonempty, false if it is empty (no transform components have been added). This is true for either a 2-d or a 3-d transform.

hasTransform2d bool EggTransform::has_transform2d(void) const; Description: Returns true if the transform is specified as a 2-d transform, e.g. with a 3x3 matrix, or false if it is specified as a 3-d transform (with a 4x4 matrix), or not specified at all. Normally, EggTextures have a 2-d matrix (but occasionally they use a 3-d matrix), and EggGroups always have a 3-d matrix.

hasTransform3d bool EggTransform::has_transform3d(void) const; Description: Returns true if the transform is specified as a 3-d transform, e.g. with a 4x4 matrix, or false if it is specified as a 2-d transform (with a 2x2 matrix), or not specified at all. Normally, EggTextures have a 3-d matrix (but occasionally they use a 3-d matrix), and EggGroups always have a 3-d matrix.

operator = EggTransform &EggTransform::operator =(EggTransform const &copy); Description:

setTransform2d void EggTransform::set_transform2d(LMatrix3d const &mat); Description: Sets the overall transform as a 3x3 matrix. This completely replaces whatever componentwise transform may have been defined.

setTransform3d void EggTransform::set_transform3d(LMatrix4d const &mat); Description: Sets the overall transform as a 4x4 matrix. This completely replaces whatever componentwise transform may have been defined.

transformIsIdentity bool EggTransform::transform_is_identity(void) const; Description: Returns true if the described transform is identity, false otherwise.

write void EggTransform::write(ostream &out, int indent_level, string const &label) const; Description: Writes the transform to the indicated stream in Egg format.