Pyrogenesis  trunk
Public Attributes | List of all members
SPropPoint Struct Reference

Describes the position of a prop point within its parent model. More...

#include <ModelDef.h>

Collaboration diagram for SPropPoint:
Collaboration graph
[legend]

Public Attributes

CStr m_Name
 Name of the prop point. More...
 
CVector3D m_Position
 Position of the point within the parent model, relative to either the parent model's origin or one of the parent model's bones if applicable. More...
 
CQuaternion m_Rotation
 Rotation of the prop model that will be attached at this point. More...
 
CMatrix3D m_Transform
 Object to parent space transformation. More...
 
u8 m_BoneIndex
 Index of parent bone to which this prop point is relative, if any. More...
 

Detailed Description

Describes the position of a prop point within its parent model.

A prop point is the location within a parent model where the prop's origin will be attached.

A prop point is specified by its transformation matrix (or separately by its position and rotation), which can be relative to either the parent model's origin, or one of the parent's bones. If the parent model is boned, then the m_BoneIndex field may specify a bone to which the transformation matrix is relative (see CModel::m_BoneMatrices). Otherwise, the transformation matrix is assumed to be relative to the parent model's origin.

See also
CModel::m_BoneMatrices

Member Data Documentation

◆ m_BoneIndex

u8 SPropPoint::m_BoneIndex

Index of parent bone to which this prop point is relative, if any.

The value 0xFF specifies that either the parent model is unboned, or that this prop point is relative to the parent model's origin rather than one if its bones.

◆ m_Name

CStr SPropPoint::m_Name

Name of the prop point.

◆ m_Position

CVector3D SPropPoint::m_Position

Position of the point within the parent model, relative to either the parent model's origin or one of the parent model's bones if applicable.

Also specified as part of m_Transform.

See also
m_Transform

◆ m_Rotation

CQuaternion SPropPoint::m_Rotation

Rotation of the prop model that will be attached at this point.

Also specified as part of m_Transform.

See also
m_Transform

◆ m_Transform

CMatrix3D SPropPoint::m_Transform

Object to parent space transformation.

Combines both m_Position and m_Rotation in a single transformation matrix. This transformation is relative to either the parent model's origin, or one of its bones, depending on whether it is skeletal. If relative to a bone, then the bone in the parent model to which this transformation is relative may be found by m_BoneIndex.

See also
m_Position, m_Rotation

The documentation for this struct was generated from the following file: