EQUINOX-3D

[1 introduction] [2 overview] [3 reference] [4 GUI]

Index

 E3dModel_ResetTransforms
 E3dModel_AppendObject
 E3dModel_InsertObject
 E3dModel_AddObject
 E3dModel_GetIndexOfObject
 E3dModel_RemoveObject
 E3dModel_RemoveInstances
 E3dModel_RemoveObjects
 E3dModel_GetBoundingBox
 E3dModel_GetTransformedBoundingBox
 E3dModel_UnselectObjects

E3dModel_ResetTransforms

Reset transformation values of a Model

Syntax
void E3dModel_ResetTransforms(E3dModel* PModel)

Argument
PModel Pointer to the Model structure
Description
Resets the transformations of the Model, by calling E3dTransformSet_Reset(), with PFreeTransformList = FALSE. Also loads an identity Matrix into LocalToWorldMatrix and LocalToWorldUnitVectorMatrix and sets the Matrix_TimeStamp to E3d_GetTime().

Return value
None.

E3dModel_AppendObject

Append an Object to a Model

Syntax
E3dObject* E3dModel_AppendObject(E3dModel* PModel, E3dObject* PObject)

Arguments
PModel Pointer to the Model PObject Object to append
Description
This function adds the given Object to the list of Geometries on the given Model. E3dObject is the base-class for:

E3dGeometry

E3dLight

E3dCamera

Return value
PObject if all went well, NULL in case of an error.

E3dModel_InsertObject

Insert an Object into a Model's Objects array before a given position

Syntax
E3dObject* E3dModel_InsertObject(E3dModel* PModel, E3dObject* PObject, const EIndex PWhere)

Arguments
PModel Pointer to the Model PObject Object to append PWhere Insert before this position
Description
This function adds the given Object to the list of Geometries on the given Model. E3dObject is the base-class for:

E3dGeometry

E3dLight

E3dCamera

Return value
PObject if all went well, NULL in case of an error.

E3dModel_AddObject

Allocate a Geometry of the given type and add it to a Model

Syntax
E3dObject* E3dModel_AddObject(E3dModel* PModel, E3dObjectClass* PClass)

Arguments
PModel Pointer to the Model PClass The type of the new Object
Description
This function allocates, initializes a Geometry of the given type and adds it to the list of Objects on the given Model.

Return value
Pointer to the new Object, or NULL in case of an error.

See also
E3dModel_AppendObject

E3dModel_GetIndexOfObject

See if a Model has the given Object

Syntax
EIndex E3dModel_GetIndexOfObject(E3dModel* PModel, E3dObject* PObject)

Arguments
PModel Pointer to the Model PObject Pointer to the Object
Description
Checks if a Model has the given Object.

Return value
The index of LObject is in the Object list of PModel. If PObject is not in the list, returns -1

E3dModel_RemoveObject

Remove Object from a Model

Syntax
void E3dModel_RemoveObject(E3dModel* PModel, E3dObject* PObject)

Arguments
PModel Pointer to the Model PObject Pointer to the Object
Description
Removes LObject from the given Model's dynamically allocated Object list.

Return value
None.

E3dModel_RemoveInstances

Free all instance records of a Model

Syntax
void E3dModel_RemoveInstances(E3dModel* PModel)

Argument
PModel Pointer to the E3dModel structure
Description
Frees all the Instance entries on PModel.

Return value
None.

See also
E3dModel_AppendObject, E3dModel_AddObject, E3dModel_RemoveObject

E3dModel_RemoveObjects

Free all Objects of a Model

Syntax
void E3dModel_RemoveObjects(E3dModel* PModel)

Argument
PModel Pointer to the E3dModel structure
Description
Frees all the Objects of PModel.

Return value
None.

See also
E3dModel_AppendObject, E3dModel_AddObject, E3dModel_RemoveObject

E3dModel_GetBoundingBox

Compute the bounding box of a Model in its local coordinate system

Syntax
EBool E3dModel_GetBoundingBox(const E3dModel* PModel, const uint32_t PWhatToInclude, const EBool PApplyScale, E3dBBox* PBBox)

Arguments
PModel Pointer to the Model PBBMin First corner of bounding box PBBMax Opposite corner of bounding box PWhatToInclude Flags to indicate what components to consider for the BBox
Description
Computes the bounding box of a Model and returns it in PBBMin and PBBMax. PWhatToInclude may be E3dBB_SELECTED_GEOMETRY or E3dBB_ALL.

Return value
TRUE if there is a valid bounding box, FALSE otherwise (e.g. the Model has no Geometries).

E3dModel_GetTransformedBoundingBox

Compute the bounding box of a Model in a given coordinate system

Syntax
EBool E3dModel_GetTransformedBoundingBox(const E3dModel* PModel, const E3dMatrix PMatrix, const uint32_t PWhatToInclude, E3dBBox* PBBox)

Arguments
PModel Pointer to the Model structure PMatrix Matrix to transform the Geometry with PBBMin First corner of bounding box PBBMax Opposite corner of bounding box PWhatToInclude OR-ed flags of what components to consider for the BBox
Description
Computes the bounding box of a Model in a coordinate system defined by a Matrix and returns it in PBBMin and PBBMax.

Return value
TRUE if there is a valid bounding box, FALSE if there isn't one (e.g. the Model has no geometry attached to it).

E3dModel_UnselectObjects

Unselect Objects of a Model

Syntax
EChangeFlags E3dModel_UnselectObjects(E3dScene* PScene, E3dModel* PModel, E3dObject** PSkipTheseObjects, const EIndex PSkipTheseObjects_Count, const uint32_t PFlags, const EBool PNotify)

Arguments
PModel Pointer to the E3dModel PSkipTheseObjects Array of pointers to E3dObjects PFlags OR-ed flags of E3dSF_OBJECTS, E3dSF_POLYGROUPS, E3dSF_POLYGONS, E3dSF_EDGES, E3dSF_VERTICES, E3dSF_SPLINE_SEGMENTS PNotify Call callbacks for the Objects
Description
Unselect Objects and components of Objects instantiated on a Model.

Return value
E3dChg... flags, indicating what changed