Cafu Engine
MapModelT Class Reference
Inheritance diagram for MapModelT:

Public Member Functions

 MapModelT (MapDocumentT &MapDoc, const wxString &ModelFileName, const Vector3fT &Position)
 
 MapModelT (MapDocumentT &MapDoc, const wxString &ModelFileName, const wxString &CollisionModelFileName, const wxString &Label, const Vector3fT &Position, const Vector3fT &Angles, float Scale, int Sequence, float FrameOffset, float FrameTimeScale, bool Animated)
 
 MapModelT (const MapModelT &Model)
 The copy constructor for copying a model. More...
 
MapModelTClone () const override
 The virtual copy constructor. More...
 
BoundingBox3fT GetBB () const
 Returns the spatial bounding-box of this map element. More...
 
void Render2D (Renderer2DT &Renderer) const
 
void Render3D (Renderer3DT &Renderer) const
 
bool TracePixel (const wxPoint &Pixel, int Radius, const ViewWindow2DT &ViewWin) const
 This method determines if this map element is intersected/affected by the specified disc in ViewWin. More...
 
wxString GetDescription () const
 
TrafoMementoTGetTrafoState () const override
 Returns a memento that encapsulates the transform-related state of this element. More...
 
void RestoreTrafoState (const TrafoMementoT *TM) override
 Restores the transform-related state of this element from the given memento. More...
 
void TrafoMove (const Vector3fT &Delta, bool LockTexCoords) override
 Translates this element by the given vector (in world-space). More...
 
void TrafoRotate (const Vector3fT &RefPoint, const cf::math::AnglesfT &Angles, bool LockTexCoords) override
 Rotates this element about the given reference point (in world-space). More...
 
void TrafoScale (const Vector3fT &RefPoint, const Vector3fT &Scale, bool LockTexCoords) override
 Scales this element about the given reference point (in world-space). More...
 
void TrafoMirror (unsigned int NormalAxis, float Dist, bool LockTexCoords) override
 Mirrors this element along the given mirror plane (in world-space). More...
 
void Transform (const Matrix4x4fT &Matrix, bool LockTexCoords) override
 Why does this method not replace all the other Trafo*() methods? This method is the most generic, allowing transformations that e.g. More...
 
void Load_cmap (TextParserT &TP, MapDocumentT &MapDoc, bool IgnoreGroups) override
 
void Save_cmap (std::ostream &OutFile, unsigned long ModelNr, const MapDocumentT &MapDoc) const
 
virtual const
cf::TypeSys::TypeInfoT
GetType () const
 
- Public Member Functions inherited from MapPrimitiveT
 MapPrimitiveT (const wxColour &Color)
 The default constructor. More...
 
 MapPrimitiveT (const MapPrimitiveT &Prim)
 The copy constructor for copying a primitive. More...
 
wxColour GetColor (bool ConsiderGroup=true) const
 This method returns the "inherent" color of this map element. More...
 
- Public Member Functions inherited from MapElementT
 MapElementT ()
 The default constructor. More...
 
 MapElementT (const MapElementT &Elem)
 The copy constructor for copying a map element. More...
 
virtual ~MapElementT ()
 The virtual destructor. More...
 
MapEditor::CompMapEntityTGetParent () const
 Returns the entity that this element is a part of, or NULL if the element has no parent entity. More...
 
void SetParent (MapEditor::CompMapEntityT *Ent)
 Sets the parent entity that is element is a part of. More...
 
bool IsSelected () const
 Returns whether this element is currently selected in the map document. More...
 
void SetSelected (bool Selected=true)
 Sets the selection state of this element. More...
 
virtual bool IsTranslucent () const
 Returns whether this map element is (entirely or partially) translucent. More...
 
GroupTGetGroup () const
 Returns NULL when this map element is in no group, or the pionter to the group it is a member of otherwise. More...
 
void SetGroup (GroupT *Group)
 Sets the group this element is a member of (use NULL for "no group"). More...
 
bool IsVisible () const
 Returns whether this map element is currently visible (in the 2D, 3D and other views). More...
 
bool CanSelect () const
 Returns whether this map element can currently be selected (in the 2D, 3D and other views). More...
 
void GetToggleEffects (ArrayT< MapElementT * > &RemoveFromSel, ArrayT< MapElementT * > &AddToSel, bool AutoGroupEntities)
 Computes how the selection must be changed in order to toggle the given element when the element's entity and group memberships are taken into account. More...
 
virtual void AdvanceTime (float t)
 This is periodically called in order to have the element advance its internal clock by t seconds. More...
 
virtual bool TraceRay (const Vector3fT &RayOrigin, const Vector3fT &RayDir, float &Fraction, unsigned long &FaceNr) const
 Traces a ray against this map element, and returns whether it was hit. More...
 
unsigned int GetFrameCount () const
 
void SetFrameCount (unsigned int FrameCount)
 

Static Public Member Functions

static void * CreateInstance (const cf::TypeSys::CreateParamsT &Params)
 
- Static Public Member Functions inherited from MapPrimitiveT
static void * CreateInstance (const cf::TypeSys::CreateParamsT &Params)
 
- Static Public Member Functions inherited from MapElementT
static void * CreateInstance (const cf::TypeSys::CreateParamsT &Params)
 

Static Public Attributes

static const cf::TypeSys::TypeInfoT TypeInfo
 
- Static Public Attributes inherited from MapPrimitiveT
static const cf::TypeSys::TypeInfoT TypeInfo
 
- Static Public Attributes inherited from MapElementT
static const cf::TypeSys::TypeInfoT TypeInfo
 

Friends

class InspDlgPrimitivePropsT
 
class CommandModifyModelT
 

Additional Inherited Members

- Protected Attributes inherited from MapElementT
MapEditor::CompMapEntityTm_Parent
 The entity that this element is a part of. More...
 
bool m_IsSelected
 Is this element currently selected in the map document? More...
 
GroupTm_Group
 The group this element is in, NULL if in no group. More...
 
unsigned int m_FrameCount
 The number of the frame in which this element was last rendered in a 3D view, used in order to avoid processing/rendering it twice. More...
 

Constructor & Destructor Documentation

MapModelT::MapModelT ( const MapModelT Model)

The copy constructor for copying a model.

Parameters
ModelThe model to copy-construct this model from.

Member Function Documentation

MapModelT * MapModelT::Clone ( ) const
overridevirtual

The virtual copy constructor.

Creates a copy of this primitive that is of the same class as the original, even when called via a base class pointer (the caller doesn't need to know the exact derived class).

Implements MapPrimitiveT.

BoundingBox3fT MapModelT::GetBB ( ) const
virtual

Returns the spatial bounding-box of this map element.

Implements MapElementT.

TrafoMementoT * MapModelT::GetTrafoState ( ) const
overridevirtual

Returns a memento that encapsulates the transform-related state of this element.

The method saves all state in the memento that calls to the Trafo*() methods can possibly modify.

Reimplemented from MapElementT.

void MapModelT::RestoreTrafoState ( const TrafoMementoT TM)
overridevirtual

Restores the transform-related state of this element from the given memento.

The method restores all state from the memento that calls to the Trafo*() methods have possibly modified.

Reimplemented from MapElementT.

bool MapModelT::TracePixel ( const wxPoint &  Pixel,
int  Radius,
const ViewWindow2DT ViewWin 
) const
virtual

This method determines if this map element is intersected/affected by the specified disc in ViewWin.

The disc for the test is defined by the given center pixel and the given radius. For example, the caller can learn by the result of this method whether the map element should respond to a mouse-click at the same pixel. Therefore, this method can be considered as the 2D analogue of the TraceRay() method.

Reimplemented from MapElementT.

void MapModelT::TrafoMirror ( unsigned int  NormalAxis,
float  Dist,
bool  LockTexCoords 
)
overridevirtual

Mirrors this element along the given mirror plane (in world-space).

Parameters
NormalAxisThe number of the axis along which the normal vector of the mirror plane points: 0, 1 or 2 for the x-, y- or z-axis respectively.
DistThe position of the mirror plane along its normal vector, where it intersects the NormalAxis.
LockTexCoordsTransform the texture-space along with the geometry. Note that the mirroring is not necessarily "perfect", because for some elements like models or plants, only their point of origin can be mirrored, but not their mesh.

Reimplemented from MapElementT.

void MapModelT::TrafoMove ( const Vector3fT Delta,
bool  LockTexCoords 
)
overridevirtual

Translates this element by the given vector (in world-space).

Parameters
DeltaThe offset by which to translate the element.
LockTexCoordsTransform the texture-space along with the geometry.

Reimplemented from MapElementT.

void MapModelT::TrafoRotate ( const Vector3fT RefPoint,
const cf::math::AnglesfT Angles,
bool  LockTexCoords 
)
overridevirtual

Rotates this element about the given reference point (in world-space).

Parameters
RefPointThe reference point (origin) for the rotation.
AnglesThe rotation angles for the three axes.
LockTexCoordsTransform the texture-space along with the geometry.

Reimplemented from MapElementT.

void MapModelT::TrafoScale ( const Vector3fT RefPoint,
const Vector3fT Scale,
bool  LockTexCoords 
)
overridevirtual

Scales this element about the given reference point (in world-space).

Parameters
RefPointThe reference point (origin) for the scale.
ScaleThe scale factors for the three axes.
LockTexCoordsTransform the texture-space along with the geometry.
Exceptions
DivisionByZeroE,e.g.when Scale is too small and the element becomes degenerate (e.g. a brush with too small faces).

Reimplemented from MapElementT.

void MapModelT::Transform ( const Matrix4x4fT Matrix,
bool  LockTexCoords 
)
overridevirtual

Why does this method not replace all the other Trafo*() methods? This method is the most generic, allowing transformations that e.g.

are non-orthogonal (like shears or non-uniform scales). This in turn conflicts with map primitives that can only store and deal with a restricted fixed set of transformations, e.g. an origin, a rotation and a uniform scale. These values cannot properly be re-computed from a general matrix with non-orthogonal basis vectors.

Parameters
MatrixThe matrix that describes the transform to be applied.
LockTexCoordsTransform the texture-space along with the geometry.

Reimplemented from MapElementT.


The documentation for this class was generated from the following files: