|
           |
  |
[1 introduction] [2 overview] [3 reference] [4 GUI] IndexE3dObject_RemoveFromModels E3dObject_LockFind E3dObject_LockAdd E3dObject_LockDel E3dSel_ObjectModelsSetSelection E3dObject_GetSelectingModel E3dObject_GetVisibleModel E3dObject_FreeRenderData E3dObjectComponent_ClassFindByName E3dObjectComponent_ClassRegister E3dObjectComponent_ClassDeactivate E3dObjectComponent_Add E3dObjectComponent_AddCopy E3dObjectComponent_Remove E3dObjectComponent_RemoveAll E3dObjectComponent_ByClass E3dObject_RemoveFromModelsRemove an Object from all Models that instantiate itSyntax Arguments Description Removes an E3dObject from all Models that instantiate it. Return value TRUE, if successful, FALSE otherwise. E3dObject_LockFindFind a Lock on an ObjectSyntax Arguments Description Returns the index of PLock in the PObject->Locks array, or E_NOT_FOUND if it's not in the array. Locks are used to indicate that an Object is in use and it's not safe to destroy the Object. For example, a Lock is added to an Object, when its attributes are being edited and a dialog box is displayed. Return value See above See also E3dObject_LockAddAdd a Lock to an ObjectSyntax Arguments Description Adds PLock to the PObject->Locks array, if it's not already in that array. Return value TRUE, if successful, otherwise FALSE. See also E3dObject_LockDelRemove lock from an ObjectSyntax Arguments Description Removes PLock from the PObject->Locks array, if it was in that array. Return value TRUE, if successful, otherwise FALSE. See also E3dSel_ObjectModelsSetSelectionSet the Selection field of the Models of an Object to a given valueSyntax Arguments Description Sets the Selection field of all Models that instantiate PObject, to PSelection. Valid values are E3dNodeSelOBJECT, E3dNodeSelNODE, E3dNodeSelBRANCH and E3dNodeSelBRANCH_ROOT. Return value None. E3dObject_GetSelectingModelFind the Model of an Object that has it selectedSyntax Arguments Description Returns the Model that instantiates PObject and causes PObject to be selected. For an Object to be considered selected, at least one of its instantiating Models must be selected (their Selection field must have the value E3dNodeSelNODE, E3dNodeSelBRANCH or E3dNodeSelBRANCH_ROOT). Or, all of these Models must be selected with E3dNodeSelOBJECT in their Selection field. The first one of such Models will be returned. This function is very useful when performing an operation on a selected Object where a world-space transformation is involved. In such case, we need to know which Model's transformation applies. Return value The first Model that causes PObject to be selected, or NULL. E3dObject_GetVisibleModelFind the first visible Model of an ObjectSyntax Argument Description Returns the first visible Model that instantiates PObject, or NULL if no such Model is found. Return value See above. E3dObject_FreeRenderDataFree rendering information of an E3dObjectSyntax Argument Description Frees cached rendering data associated with an E3dObject by calling the E3dObject's FreeRenderData() member function. Such data may be large and can be recomputed when needed, so to save memory, it is usually freed when an E3dObject is deleted from the Scene and added to the undo stack. Return value None. See also E3dObjectComponent_ClassFindByNameFind an ObjectComponentClass by its nameSyntax Argument Description Finds a registered E3dObjectComponentClass by name. Return value Pointer to the E3dObjectComponentClass, if found, otherwise NULL. E3dObjectComponent_ClassRegisterRegister a new ObjectComponent classSyntax Argument Description Registers a new E3dObjectComponentClass. Runtime-typed E3dObjectComponent records can be stored on E3dObjects to provide all kinds of dynamic information, such as: - Construction history (e.g. a Mesh will remember that it's a "Torus", or that it was created by "revolving" a Spline) - Dynamic modeling data, such as subdivision information (a subdivision surface is just an E3dMesh with an E3dObjectComponent) - Fluid simulation data and code, such as particles and/or wave information - Custom data, such as real-time global illumination information on the Vertices of a Mesh practically anything... Return value Pointer to the new E3dObjectComponentClass, or NULL in case of an error. See also E3dObjectComponent_ClassFindByName, E3dObjectComponent_ClassDeactivate, E3dObjectComponent_ClassesFree See also E3dObjectComponent_ClassDeactivateDeactivate an ObjectComponentClassSyntax Argument Description Clears member function pointers etc. in the given Class, but keeps the Class registered. Usually called when the plugin that registered the Class is unloaded to be edited and reloaded on the fly. This allows for keeping the data associated with this class on instances when the code needs to be changed. The Class can be later re-activated when the plugin is reloaded. For example, if a bug is found in the Sphere plugin while testing a scene with, say 500 spheres, the plugin can be unloaded/changed/reloaded all without exiting EQUINOX-3D or deleting/recreating the 500 spheres. Return value None. See also E3dObjectComponent_AddAdd an Component of a given Class to an ObjectSyntax Arguments Description Creates a new ObjectComponent of the given Class and adds it to the PObject->Components array. Return value Pointer to the new ObjectComponent, or NULL, in case of an error. See also E3dObjectComponent_AddCopyCopy an ObjectComponent and add it to an ObjectSyntax Arguments Description Creates a copy of the given ObjectComponent and adds it to PDstObject. Return value Pointer to the new ObjectComponent, or NULL, in case of an error. See also E3dObjectComponent_RemoveRemove Component from an ObjectSyntax Arguments Description Removes PComponent from the PObject->Components array (if it's in that array) and destroys PComponent. Return value TRUE, if successful, otherwise FALSE. See also E3dObjectComponent_RemoveAllRemove all Components from an ObjectSyntax Argument Description Removes all Components from the PObject->Components array and destroys those Components. Return value None. See also E3dObjectComponent_ByClassFind Component of an Object by its ClassSyntax Arguments Description Returns the first Component in PObject->Components array that matches the given Class. Return value Pointer to the Component, or NULL, if no Component matching PClass was found. See also |