Panda3D
Public Member Functions | Static Public Member Functions | List of all members
EggXfmSAnim Class Reference

This corresponds to an <Xfm$Anim_S$> entry, which is a collection of up to nine <S$Anim> entries that specify the nine components of a transformation. More...

Inheritance diagram for EggXfmSAnim:
EggGroupNode EggNode EggNamedObject EggObject Namable TypedReferenceCount TypedObject ReferenceCount

Public Member Functions

 __init__ (const EggXfmAnimData convert_from)
 Converts the older-style XfmAnim table to the newer-style XfmSAnim table. More...
 
 __init__ (const EggXfmSAnim copy)
 
 __init__ (str name, CoordinateSystem cs)
 
 addComponentData (int component, double value)
 Adds a new row to the indicated component (0-12) of the table. More...
 
 addComponentData (str component_name, double value)
 Adds a new row to the named component (one of matrix_component_letters) of the table. More...
 
bool addData (const LMatrix4d mat)
 Adds a new matrix to the table, by adding a new row to each of the subtables. More...
 
 clearData ()
 Removes all data from the table. More...
 
 clearFps ()
 
 clearOrder ()
 
CoordinateSystem getCoordinateSystem ()
 Returns the coordinate system this table believes it is defined within. More...
 
double getFps ()
 This is only valid if has_fps() returns true. More...
 
int getNumRows ()
 Returns the effective number of rows in the table. More...
 
str getOrder ()
 
 getValue (int row, LMatrix4d mat)
 Returns the value of the aggregate row of the table as a matrix. More...
 
bool hasFps ()
 
bool hasOrder ()
 
 normalize ()
 The inverse operation of optimize(), this ensures that all the sub-tables have the same length by duplicating rows as necessary. More...
 
EggXfmSAnim operator= (const EggXfmSAnim copy)
 
 optimize ()
 Optimizes the table by collapsing redundant sub-tables. More...
 
 optimizeToStandardOrder ()
 Optimizes the table by collapsing redundant sub-tables, and simultaneously ensures that the order string is the standard order (which is the same as that supported by compose_matrix() and decompose_matrix()). More...
 
 setFps (double fps)
 
 setOrder (str order)
 
bool setValue (int row, const LMatrix4d mat)
 Replaces the indicated row of the table with the given matrix. More...
 
- Public Member Functions inherited from EggGroupNode
 __init__ (const EggGroupNode copy)
 
 __init__ (str name)
 
EggNode addChild (EggNode node)
 Adds the indicated child to the group and returns it. More...
 
 applyFirstAttribute (bool recurse)
 Sets the first vertex of the triangle (or each component) to the primitive normal and/or color, if the primitive is flat-shaded. More...
 
 applyLastAttribute (bool recurse)
 Sets the last vertex of the triangle (or each component) to the primitive normal and/or color, if the primitive is flat-shaded. More...
 
 clear ()
 
 clearConnectedShading ()
 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(). More...
 
bool empty ()
 
EggNode findChild (str name)
 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. More...
 
 forceFilenames (const Filename directory)
 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. More...
 
object getChildren ()
 
 getConnectedShading ()
 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. More...
 
EggNode getFirstChild ()
 Returns the first child in the group's list of children, or NULL if the list of children is empty. More...
 
EggNode getNextChild ()
 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. More...
 
bool hasAbsolutePathnames ()
 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. More...
 
bool hasNormals ()
 Returns true if any of the primitives (e.g. More...
 
bool hasPrimitives ()
 Returns true if there are any primitives (e.g. More...
 
bool jointHasPrimitives ()
 Returns true if there are any primitives (e.g. More...
 
 makePointPrimitives ()
 Creates PointLight primitives to reference any otherwise unreferences vertices discovered in this group or below. More...
 
 meshTriangles (int flags)
 Combine triangles together into triangle strips, at this group and below. More...
 
EggGroupNode operator= (const EggGroupNode copy)
 
 postApplyFlatAttribute (bool recurse)
 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. More...
 
 recomputePolygonNormals (CoordinateSystem cs)
 Recomputes all the polygon normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. More...
 
bool recomputeTangentBinormal (const GlobPattern uv_name)
 This function recomputes the tangent and binormal for the named texture coordinate set for all vertices at this level and below. More...
 
bool recomputeTangentBinormal (const VectorString names)
 This function recomputes the tangent and binormal for the named texture coordinate sets. More...
 
bool recomputeTangentBinormalAuto ()
 This function recomputes the tangent and binormal for any texture coordinate set that affects a normal map. More...
 
 recomputeVertexNormals (double threshold, CoordinateSystem cs)
 Recomputes all the vertex normals for polygon geometry at this group node and below so that they accurately reflect the vertex positions. More...
 
EggNode removeChild (EggNode node)
 Removes the indicated child node from the group and returns it. More...
 
int removeInvalidPrimitives (bool recurse)
 Removes primitives at this level and below which appear to be degenerate; e.g. More...
 
int removeUnusedVertices (bool recurse)
 Removes all vertices from VertexPools within this group or below that are not referenced by at least one primitive. More...
 
int renameNodes (VectorString strip_prefix, bool recurse)
 Rename by stripping out the prefix. More...
 
 resolveFilenames (const DSearchPath searchpath)
 Walks the tree and attempts to resolve any filenames encountered. More...
 
 reverseVertexOrdering ()
 Reverses the vertex ordering of all polygons defined at this node and below. More...
 
EggGroupNode::SizeType size ()
 
 stealChildren (EggGroupNode other)
 Moves all the children from the other node to this one. More...
 
 stripNormals ()
 Removes all normals from primitives, and the vertices they reference, at this node and below. More...
 
int triangulatePolygons (int flags)
 Replace all higher-order polygons at this point in the scene graph and below with triangles. More...
 
 unifyAttributes (bool use_connected_shading, bool allow_per_primitive, bool recurse)
 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. 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 composeWithOrder (LMatrix4d mat, const LVecBase3d scale, const LVecBase3d shear, const LVecBase3d hpr, const LVecBase3d trans, str order, CoordinateSystem cs)
 Composes a matrix out of the nine individual components, respecting the order string. More...
 
static TypeHandle getClassType ()
 
static str getStandardOrder ()
 Returns the standard order of matrix component composition. More...
 
- Static Public Member Functions inherited from EggGroupNode
static TypeHandle getClassType ()
 
static bool isRight (const LVector2d v1, const LVector2d v2)
 Returns true if the 2-d v1 is to the right of v2. More...
 
- 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 ()
 

Additional Inherited Members

- Public Types inherited from EggGroupNode
enum  TriangulateFlags {
  T_polygon = 1, T_convex = 2, T_composite = 4, T_recurse = 8,
  T_flat_shaded = 16
}
 
- Public Attributes inherited from EggGroupNode
object children
 
- 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
 

Detailed Description

This corresponds to an <Xfm$Anim_S$> entry, which is a collection of up to nine <S$Anim> entries that specify the nine components of a transformation.

It's implemented as a group that can contain any number of EggSAnimData children.

Member Function Documentation

◆ __init__() [1/3]

__init__ ( const EggXfmAnimData  convert_from)

Converts the older-style XfmAnim table to the newer-style XfmSAnim table.

◆ __init__() [2/3]

__init__ ( const EggXfmSAnim  copy)

◆ __init__() [3/3]

__init__ ( str  name,
CoordinateSystem  cs 
)

◆ addComponentData() [1/2]

addComponentData ( int  component,
double  value 
)

Adds a new row to the indicated component (0-12) of the table.

◆ addComponentData() [2/2]

addComponentData ( str  component_name,
double  value 
)

Adds a new row to the named component (one of matrix_component_letters) of the table.

◆ addData()

bool addData ( const LMatrix4d  mat)

Adds a new matrix to the table, by adding a new row to each of the subtables.

This is a convenience function that treats the table of tables as if it were a single table of matrices. It is an error to call this if any SAnimData children of this node have an improper name (e.g. not a single letter, or not one of "ijkabchprxyz").

This function has the further requirement that all nine of the subtables must exist and be of the same length. Furthermore, the order string must be the standard order string, which matches the system compose_matrix() and decompose_matrix() functions.

Thus, you probably cannot take an existing EggXfmSAnim object and start adding matrices to the end; you must clear out the original data first. (As a special exception, if no tables exist, they will be created.) The method normalize() will do this for you on an existing EggXfmSAnim.

This function may fail silently if the matrix cannot be decomposed into scale, shear, rotate, and translate. In this case, the closest approximation is added to the table, and false is returned.

◆ clearData()

clearData ( )

Removes all data from the table.

It does this by removing all of its children.

◆ clearFps()

clearFps ( )

◆ clearOrder()

clearOrder ( )

◆ composeWithOrder()

static composeWithOrder ( LMatrix4d  mat,
const LVecBase3d  scale,
const LVecBase3d  shear,
const LVecBase3d  hpr,
const LVecBase3d  trans,
str  order,
CoordinateSystem  cs 
)
static

Composes a matrix out of the nine individual components, respecting the order string.

The components will be applied in the order indicated by the string.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getCoordinateSystem()

CoordinateSystem getCoordinateSystem ( )

Returns the coordinate system this table believes it is defined within.

This should always match the coordinate system of the EggData structure that owns it. It is necessary to store it here because the meaning of the h, p, and r columns depends on the coordinate system.

◆ getFps()

double getFps ( )

This is only valid if has_fps() returns true.

◆ getNumRows()

int getNumRows ( )

Returns the effective number of rows in the table.

This is actually the number of rows of the smallest subtable larger than one row. This is a convenience function that treats the table of tables as if it were a single table of matrices.

◆ getOrder()

str getOrder ( )

◆ getStandardOrder()

static str getStandardOrder ( )
static

Returns the standard order of matrix component composition.

This is what the order string must be set to in order to use set_value() or add_data() successfully.

◆ getValue()

getValue ( int  row,
LMatrix4d  mat 
)

Returns the value of the aggregate row of the table as a matrix.

This is a convenience function that treats the table of tables as if it were a single table of matrices. It is an error to call this if any SAnimData children of this node have an improper name (e.g. not a single letter, or not one of "ijkabchprxyz").

◆ hasFps()

bool hasFps ( )

◆ hasOrder()

bool hasOrder ( )

◆ normalize()

normalize ( )

The inverse operation of optimize(), this ensures that all the sub-tables have the same length by duplicating rows as necessary.

This is needed before doing operations like add_data() or set_value() on an existing table.

◆ operator=()

EggXfmSAnim operator= ( const EggXfmSAnim  copy)

◆ optimize()

optimize ( )

Optimizes the table by collapsing redundant sub-tables.

◆ optimizeToStandardOrder()

optimizeToStandardOrder ( )

Optimizes the table by collapsing redundant sub-tables, and simultaneously ensures that the order string is the standard order (which is the same as that supported by compose_matrix() and decompose_matrix()).

◆ setFps()

setFps ( double  fps)

◆ setOrder()

setOrder ( str  order)

◆ setValue()

bool setValue ( int  row,
const LMatrix4d  mat 
)

Replaces the indicated row of the table with the given matrix.

This function can only be called if all the constraints of add_data(), below, are met. Call normalize() first if you are not sure.

The return value is true if the matrix can be decomposed and stored as scale, shear, rotate, and translate, or false otherwise. The data is set in either case.