Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Friends | List of all members
OsdMesh Class Reference
Inheritance diagram for OsdMesh:
GeometryObject ResourceData EventObject CoreCustomData CoreBaseObject CoreBaseType

Public Types

enum  CompressionMode {
  COMPRESSION_DISABLED,
  COMPRESSION_ENABLED,
  COMPRESSION_AUTOMATIC
}
 

Public Member Functions

 OsdMesh (const OsdMesh &other)
 
virtual GeometryObjectget_copy () const override
 Get a copy of the current geometry.
 
virtual GMathBbox3d get_bbox () const override
 Get bounding box of the geometry.
 
virtual GMathBbox3d get_bbox_at (const CtxEval &eval_ctx, const double &time) const override
 Get the bounding box of the geometry for the given time.
 
virtual GMathBbox3d get_shading_group_bbox (const unsigned int &id) const override
 Get the bounding box of a shading group.
 
virtual const CoreBasicArray
< CoreString > & 
get_shading_group_names () const override
 Get the list of shading groups defined in the geometry.
 
virtual unsigned int get_uv_map_count () const override
 Get the number of UV maps defined in the geometry.
 
virtual const CoreStringget_uv_map_name (const unsigned int &uv_map_index) const override
 Get the name of a UV map.
 
virtual bool get_uv_map_data (const unsigned int &uv_map_index, CoreArray< GMathVec3f > &uvs, CoreArray< unsigned int > &indices) const override
 Get the data of a UV map.
 
virtual void compute_fragment_uvw (const CtxEval &eval_ctx, const GeometryFragment &fragment, const unsigned int &uv_map_index, GMathVec3d &coord, GMathVec3d &dcdu, GMathVec3d &dcdv) const override
 Compute UVW coordinates and derivatives in a UV map for the requested fragment.
 
virtual void compute_edge_uvw (const CtxEval &eval_ctx, const unsigned int &primitive_index, const unsigned int &edge_index, const unsigned int &uv_map_index, const double &t, GMathVec3d &coord) const override
 Compute UVW coordinates and derivatives in a UV map on an edge.
 
virtual unsigned int get_color_map_count () const override
 Get the number of color maps defined in the geometry.
 
virtual const CoreStringget_color_map_name (const unsigned int &color_map_index) const override
 Get the name of a color map.
 
virtual bool get_color_map_data (const unsigned int &color_map_index, CoreArray< GMathVec4uc > &colors, CoreArray< unsigned int > &indices) const override
 Get the data of a color map.
 
virtual void compute_fragment_color (const CtxEval &eval_ctx, const GeometryFragment &fragment, const unsigned int &color_map_index, GMathVec4f &color) const override
 Compute the value of a color map for the requested fragment.
 
virtual bool is_primitive_uv_mapped (const unsigned int &primitive_id, const unsigned int &uv_map_index) const override
 Tell if a primitive has a representation in a UV map.
 
virtual bool is_primitive_edge_visible (const unsigned int &primitive_index, const unsigned int &edge_index) const override
 Tell if an edge is visible.
 
virtual bool is_geometry_linear () const override
 Tell if the geometry is linear.
 
virtual bool is_primitive_linear (const unsigned int &primitive_index) const override
 Tell if a primitive is linear.
 
virtual bool is_primitive_edge_linear (const unsigned int &primitive_index, const unsigned int &edge_index) const override
 Tell if an edge on a primitive is linear.
 
virtual void get_primitive_indices (CoreArray< unsigned int > &indices) const override
 Get the list of vertex indices that define all primitives.
 
virtual bool is_animated () const override
 Indicate if the geometry has an animation for the current frame.
 
virtual const GeometryPointCloudget_point_cloud () const override
 Get the point cloud defined by the geometry.
 
virtual bool set_point_cloud (const GeometryPointCloud &point_cloud, AppProgressBar *progress_bar=0) override
 Replace the point cloud.
 
virtual unsigned int get_vertex_count () const override
 Get the number of vertices in the geometry.
 
virtual unsigned int get_primitive_count () const override
 Get the number of primitives in the geometry.
 
unsigned int get_primitive_index_count () const
 
virtual unsigned int get_primitive_edge_count (const unsigned int &id) const override
 Get the number of edges of a primitive.
 
virtual unsigned int get_primitive_shading_group_index (const unsigned int &id) const override
 Get the ID of the shading group to which belongs a primitive.
 
unsigned int get_primitive_polygon_id (const unsigned int &id) const
 Get the ID of the original polygon from which the primitive has been created.
 
virtual void compute_primitive_bbox (const CtxEval &eval_ctx, const unsigned int &id, GMathBbox3d &bbox) const override
 Compute the bounding box of a primitive.
 
virtual void compute_primitive_bbox_at (const CtxEval &eval_ctx, const unsigned int &id, const double &time, GMathBbox3d &bbox) const override
 Compute the bounding box of a primitive at a given time.
 
virtual double estimate_area (const CtxEval &eval_ctx, const GMathMatrix4x4d &xform) const override
 Compute an estimation of the area of the geometry.
 
virtual double estimate_shading_group_area (const CtxEval &eval_ctx, const unsigned int &id, const GMathMatrix4x4d &xform) const override
 Compute an estimation of the area of a shading group.
 
virtual double estimate_primitive_area (const CtxEval &eval_ctx, const unsigned int &id, const GMathMatrix4x4d &xform) const override
 Compute an estimation of the area of a primitive.
 
unsigned int get_primitive_vertices (const GMathTimeSampling &time_sampling, const GeometrySampleDescriptor &sd, GMathVec3d vertices[4]) const
 
virtual void compute_fragment_sample (const CtxEval &eval_ctx, const GeometryFragment &fragment, GeometrySample &sample) const override
 Compute a sample (position, derivatives, normals) on the geometry for a given fragment.
 
virtual void intersect_primitive (const CtxEval &eval_ctx, const unsigned int &id, GeometryRaytraceCtx &raytrace_ctx) const override
 Compute the list of intersections between rays and a primitive.
 
virtual void intersect_primitive (const CtxEval &eval_ctx, const unsigned int &id, GeometryFrustumCtx &frustum_ctx) const override
 Compute the intersection between a frustum and a primitive.
 
virtual size_t get_memory_size () const override
 Get the amount of memory occupied by the resource.
 
void print_stats () const
 Print some statistics about the mesh (vertex count, primitive count, uv maps, etc...)
 
void set (const CoreBasicArray< GMathVec3f > &vertices, const CoreBasicArray< GMathVec3f > &velocities, const CoreBasicArray< unsigned int > &polygon_indices, const CoreBasicArray< unsigned int > &polygon_vertex_count, const CoreBasicArray< unsigned int > &polygon_shading_groups, const CoreBasicArray< CoreString > &shading_group_names, const CoreBasicArray< GeometryUvMap > &uv_maps, const CoreBasicArray< GeometryColorMap > &color_maps, const unsigned int level_subdivision, const OsdMeshTopology *osd_mesh_topology, const OsdMeshMaps *osd_mesh_maps, AppProgressBar *progress_bar=0)
 Build the mesh from external data.
 
void set_creases (const CoreArray< unsigned int > &polygon_crease_indices, const CoreArray< double > &polygon_crease_length)
 
void set_primitive_edge_visibility (const unsigned int &primitive_index, const unsigned int &edge_index, const bool &is_visible)
 Set the visibility of an edge.
 
unsigned int get_polygon_count () const
 Get the number of polygons that were used to build the mesh.
 
void get_polygon_vertex_indices (CoreArray< unsigned int > &polygon_vertex_indices) const
 Get the list of vertex indices that define all polygons.
 
void get_polygon_vertex_count (CoreArray< unsigned int > &polygon_vertex_count) const
 Get the array of vertex count for all polygons.
 
void get_polygon_shading_groups (CoreArray< unsigned int > &polygon_shading_groups) const
 Get the shading group IDs for each polygon.
 
virtual Core128BitHashKey get_hash_key () const override
 Get the hash key of the resource.
 
void get_face_from_refiner (const CoreArray< unsigned int > &old_polygon_shading_groups, CoreArray< unsigned int > &new_faces, CoreArray< unsigned int > &polygon_shading_groups, CoreArray< unsigned int > &polygon_vertices_count)
 Get the faces, the number of vertex per face and the polygon shadong group form a refiner and a level of subdivision.
 
void set_subdivide (unsigned int subdivision_level, OsdMeshTopology *osd_mesh_topology, const OsdMeshGeometry *original_geometry, OsdMeshMaps *osd_mesh_maps, AppProgressBar *progress_bar, AppProgressBar *progress_bar_osd)
 Set the parameters to do the subdivision.
 
void subdivide (const OsdMeshGeometry *original_geometry)
 Subdivide the mesh.
 
void update_subdivide (const OsdMeshGeometry *osd_mesh_geometry, const OsdMeshMaps *osd_mesh_maps, OsdMesh *open_subdiv_res)
 Update the values of the subdivision with the new informations.
 
void create_refiner (const OsdMeshGeometry *original_geometry)
 Create a refiner which allows the subdivision.
 
const
IX_OPENSUBDIV::Far::StencilTable * 
get_stencil_table () const
 
const
IX_OPENSUBDIV::Far::TopologyRefiner * 
get_refiner () const
 
const
IX_OPENSUBDIV::Far::PrimvarRefiner * 
get_primvar_refiner () const
 
const unsigned int & get_subdivision_level () const
 
- Public Member Functions inherited from GeometryObject
 GeometryObject (const GeometryObject &other)
 
virtual void compute_primitive_space (const CtxEval &eval_ctx, const unsigned int &id, GMathLinearSpace3d &space) const
 Compute the space of a primitive.
 
virtual void compute_primitive_bbox (const CtxEval &eval_ctx, const unsigned int &id, const GMathLinearSpace3d &xform, GMathBbox3d &bbox) const
 Compute the bounding box of a primitive.
 
virtual void compute_primitive_bbox_at (const CtxEval &eval_ctx, const unsigned int &id, const GMathLinearSpace3d &xform, const double &time, GMathBbox3d &bbox) const
 Compute the bounding box of a primitive at a given time.
 
const CoreStringget_primitive_shading_group_name (const unsigned int &id) const
 Get the name of the shading group to which belongs a primitive.
 
bool get_uv_map_index (const CoreString &uv_map_name, unsigned int &uv_map_index) const
 Get the index of a UV map by name.
 
bool get_uv_map (const unsigned int &uv_map_index, GeometryUvMap &uv_map) const
 Get a UV map.
 
void get_uv_maps (CoreArray< GeometryUvMap > &uv_maps) const
 Get all UV maps.
 
bool get_color_map (const unsigned int &color_map_index, GeometryColorMap &color_map) const
 Get a color map.
 
void get_color_maps (CoreArray< GeometryColorMap > &color_maps) const
 Get all color maps.
 
virtual unsigned int get_normal_map_count () const
 Get the number of normal maps defined in the geometry.
 
virtual const CoreStringget_normal_map_name (const unsigned int &normal_map_index) const
 Get the name of a normal map.
 
virtual bool get_normal_map_data (const unsigned int &normal_map_index, CoreArray< GMathVec3f > &normals, CoreArray< unsigned int > &indices) const
 Get the description of a normal map.
 
bool get_normal_map (const unsigned int &normal_map_index, GeometryNormalMap &normal_map) const
 Get a normal map.
 
void get_normal_maps (CoreArray< GeometryNormalMap > &normal_maps) const
 Get all normal maps.
 
virtual void compute_edge_sample (const CtxEval &eval_ctx, const unsigned int &primitive_id, const unsigned int &edge_index, const double &t, const GMathVec3d &eye_dir, GeometrySample &sample) const
 Compute a sample (position, derivatives, normals) on an edge of the geometry.
 
virtual double get_primitive_intersection_cost () const
 Return an estimation of the intersection cost of primitives.
 
void get_uv_tiles (const GeometryUvMap &uv_map, CoreArray< GeometryUvTile > &tiles) const
 Get the non empty UV tiles from a uv map.
 
void get_uv_tiles (const int &index, CoreArray< GeometryUvTile > &tiles) const
 Get the non empty UV tiles from the geometry's uv map at an index.
 
GMathVec4f get_uv_range (const GeometryUvMap &uv_map) const
 
GMathVec4f get_uv_range (const unsigned int &uv_map_index) const
 
- Public Member Functions inherited from ResourceData
 ResourceData (const ResourceData &other)
 
ResourceImportDataget_import_data () const
 
void set_import_data (ResourceImportData *data)
 
virtual bool is_serializable () const
 Tell if the resource can be serialized or not.
 
virtual void * serialize (size_t &serial_size) const
 Serialize the resource data.
 
virtual bool deserialize (void *serial, const size_t &serial_size)
 Deserialize the resource data.
 
void advert_memory_changed () const
 Adverts that the memory usage of the resource has changed.
 
bool is_protected () const
 
- Public Member Functions inherited from EventObject
 EventObject ()
 Constructor.
 
 EventObject (const EventObject &src)
 Copy Constructor.
 
virtual ~EventObject () override
 Destructor.
 
void connect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event.
 
void connect (EventObject &sender, EventInfoMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events.
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoMethod event_cb, void *data=0)
 
bool disconnect_all (EventObject &sender)
 Disconnects from all objects sender was listening on.
 
void disconnect_all ()
 Disconnects from all objects we were listening on.
 
void remove_all_connection ()
 Disconnects object from other objects it is listening to, and also disconnects all objects listening to it.
 
void raise_event (const CoreString &event_id) const
 sends an event
 
void raise_event (const EventInfo &event_info) const
 sends an event
 
bool is_connected (EventObject &sender, const CoreString &event_id, void *data)
 
void set_mute (const bool &mute)
 Asks for object muting. This will increase or decrease the muting counter. Unmuting may not be immediat since it will happen only when counter reaches 0.
 
bool is_mute () const
 Returns if object is muted.
 
CoreArray< EventObject * > get_senders () const
 
unsigned int get_sender_count () const
 
unsigned int get_receiver_count () const
 
void connect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Connects this to an object to listen to a specific event.
 
void connect (EventObject &sender, EventMethod event_cb, void *data=0)
 Connects this to an object to listen any of its events.
 
bool disconnect (EventObject &sender, const CoreString &event_id, EventMethod event_cb, void *data=0)
 Disconnects this from an object for a specific event.
 
- Public Member Functions inherited from CoreCustomData
 CoreCustomData (const CoreCustomData &src)
 
void add_custom_data (void *key, const bool &data)
 
void add_custom_data (void *key, const int &data)
 
void add_custom_data (void *key, const unsigned int &data)
 
void add_custom_data (void *key, const char *data)
 
void add_custom_data (void *key, const CoreString &data)
 
void add_custom_data (void *key, const double &data)
 
void add_custom_data (void *key, void *data)
 
void remove_custom_data (void *key)
 
void remove_all_custom_data ()
 
void set_custom_data (void *key, const bool &data)
 
void set_custom_data (void *key, const int &data)
 
void set_custom_data (void *key, const unsigned int &data)
 
void set_custom_data (void *key, const double &data)
 
void set_custom_data (void *key, const char *data)
 
void set_custom_data (void *key, const CoreString &data)
 
void set_custom_data (void *key, void *data)
 
void get_custom_data (void *key, bool &data) const
 
void get_custom_data (void *key, int &data) const
 
void get_custom_data (void *key, unsigned int &data) const
 
void get_custom_data (void *key, double &data) const
 
void get_custom_data (void *key, CoreString &data) const
 
void get_custom_data (void *key, void *&data) const
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
CoreString get_class_info_name () const
 
const unsigned long & get_class_info_id () const
 
virtual bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Friends

class OpenSubdivMeshSmoothed
 
class OsdMeshProperty
 

Additional Inherited Members

- Static Public Member Functions inherited from EventObject
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventInfoMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event.
 
static void connect (EventObject &sender, EventInfoFunction event_cb, void *data=0)
 Connects to an object to listen any of its events.
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventInfoFunction event_cb, void *data=0)
 
static void raise_event (EventObject &sender, const CoreString &event_id)
 Sends an event.
 
static void raise_event (EventObject &sender, const EventInfo &event_info)
 Sends an event.
 
static void connect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Connects to an object to listen to a specific event.
 
static void connect (EventObject &sender, EventFunction event_cb, void *data=0)
 Connects to an object to listen any of its events.
 
static void connect (EventObject &sender, const CoreString &event_id, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static void connect (EventObject &sender, EventObject &receiver, EventMethod event_cb, void *data=0)
 Static version of the above function.
 
static bool disconnect (EventObject &sender, const CoreString &event_id, EventFunction event_cb, void *data=0)
 Disconnects this from an object for a specific event.
 

Member Function Documentation

void OsdMesh::compute_edge_uvw ( const CtxEval eval_ctx,
const unsigned int &  primitive_index,
const unsigned int &  edge_index,
const unsigned int &  uv_map_index,
const double &  t,
GMathVec3d &  coord 
) const
overridevirtual

Compute UVW coordinates and derivatives in a UV map on an edge.

Parameters
[in]eval_ctxa valid evaluation context
[in]primitive_indexthe ID of the primitive to which the edge belongs
[in]edge_indexthe ID of the edge on the primitive
[in]uv_map_indexthe ID of the UV map to use
[in]tposition on the edge [0 - 1.0]
[out]coordoutput UVW coordinates in the UV map

Reimplemented from GeometryObject.

void OsdMesh::compute_fragment_color ( const CtxEval eval_ctx,
const GeometryFragment fragment,
const unsigned int &  color_map_index,
GMathVec4f &  color 
) const
overridevirtual

Compute the value of a color map for the requested fragment.

Parameters
[in]eval_ctxa valid evaluation context
[in]fragmentthe requested fragment
[in]color_map_indexthe ID of the color map to use
[out]coloroutput value

Reimplemented from GeometryObject.

void OsdMesh::compute_fragment_sample ( const CtxEval eval_ctx,
const GeometryFragment fragment,
GeometrySample sample 
) const
overridevirtual

Compute a sample (position, derivatives, normals) on the geometry for a given fragment.

Parameters
[in]eval_ctxa valid evaluation context
[in]fragmentthe requested fragment
[out]sampleoutput sample

Implements GeometryObject.

void OsdMesh::compute_fragment_uvw ( const CtxEval eval_ctx,
const GeometryFragment fragment,
const unsigned int &  uv_map_index,
GMathVec3d &  coord,
GMathVec3d &  dcdu,
GMathVec3d &  dcdv 
) const
overridevirtual

Compute UVW coordinates and derivatives in a UV map for the requested fragment.

Parameters
[in]eval_ctxa valid evaluation context
[in]fragmentthe requested fragment
[in]uv_map_indexthe ID of the UV map to use
[out]coordoutput UVW coordinates in the UV map
[out]dcducoordinates derivative along the primitive parametric U axis
[out]dcdvcoordinates derivative along the primitive parametric V axis

Reimplemented from GeometryObject.

void OsdMesh::compute_primitive_bbox ( const CtxEval eval_ctx,
const unsigned int &  id,
GMathBbox3d &  bbox 
) const
overridevirtual

Compute the bounding box of a primitive.

Parameters
[in]eval_ctxa valid evaluation context
[in]idthe ID of the primitive
[out]bboxthe returned bounding box

Implements GeometryObject.

void OsdMesh::compute_primitive_bbox_at ( const CtxEval eval_ctx,
const unsigned int &  id,
const double &  time,
GMathBbox3d &  bbox 
) const
overridevirtual

Compute the bounding box of a primitive at a given time.

Parameters
[in]eval_ctxa valid evaluation context
[in]idthe ID of the primitive
[in]timethe local time (relative to the current frame)
[out]bboxthe returned bounding box

Reimplemented from GeometryObject.

void OsdMesh::create_refiner ( const OsdMeshGeometry original_geometry)

Create a refiner which allows the subdivision.

Parameters
[in]osd_mesh_geometryIt contains the geometry's information of the original mesh
double OsdMesh::estimate_area ( const CtxEval eval_ctx,
const GMathMatrix4x4d &  xform 
) const
overridevirtual

Compute an estimation of the area of the geometry.

Parameters
[in]eval_ctxa valid evaluation context
[in]xformthe transformation matrix of the geometry
Returns
an estimation of the area

Reimplemented from GeometryObject.

double OsdMesh::estimate_primitive_area ( const CtxEval eval_ctx,
const unsigned int &  id,
const GMathMatrix4x4d &  xform 
) const
overridevirtual

Compute an estimation of the area of a primitive.

Parameters
[in]eval_ctxa valid evaluation context
[in]idthe ID of the primitive
[in]xformthe transformation matrix of the geometry
Returns
an estimation of the area

Reimplemented from GeometryObject.

double OsdMesh::estimate_shading_group_area ( const CtxEval eval_ctx,
const unsigned int &  id,
const GMathMatrix4x4d &  xform 
) const
overridevirtual

Compute an estimation of the area of a shading group.

Parameters
[in]eval_ctxa valid evaluation context
[in]idthe ID of the shading group
[in]xformthe transformation matrix of the geometry
Returns
an estimation of the area

Reimplemented from GeometryObject.

GMathBbox3d OsdMesh::get_bbox ( ) const
overridevirtual

Get bounding box of the geometry.

Returns
the bounding box

Implements GeometryObject.

GMathBbox3d OsdMesh::get_bbox_at ( const CtxEval eval_ctx,
const double &  time 
) const
overridevirtual

Get the bounding box of the geometry for the given time.

Parameters
[in]eval_ctxa valid evaluation context
[in]timethe local time (relative to the current frame)
Returns
the bounding box

Reimplemented from GeometryObject.

unsigned int OsdMesh::get_color_map_count ( ) const
overridevirtual

Get the number of color maps defined in the geometry.

Returns
the number of color maps

Reimplemented from GeometryObject.

bool OsdMesh::get_color_map_data ( const unsigned int &  color_map_index,
CoreArray< GMathVec4uc > &  colors,
CoreArray< unsigned int > &  indices 
) const
overridevirtual

Get the data of a color map.

Parameters
[in]color_map_indexthe ID of the color map
[out]colorsthe array of colors
[out]indicesthe indices to the colors for each primitive
Returns
true if the description for the color map can be retrieved, else false

Reimplemented from GeometryObject.

const CoreString & OsdMesh::get_color_map_name ( const unsigned int &  color_map_index) const
overridevirtual

Get the name of a color map.

Parameters
[in]color_map_indexthe ID of the color map
Returns
the name of the color map

Reimplemented from GeometryObject.

GeometryObject * OsdMesh::get_copy ( ) const
overridevirtual

Get a copy of the current geometry.

Returns
a new object that is the copy of the current one

Implements GeometryObject.

void OsdMesh::get_face_from_refiner ( const CoreArray< unsigned int > &  old_polygon_shading_groups,
CoreArray< unsigned int > &  new_faces,
CoreArray< unsigned int > &  polygon_shading_groups,
CoreArray< unsigned int > &  polygon_vertices_count 
)

Get the faces, the number of vertex per face and the polygon shadong group form a refiner and a level of subdivision.

Parameters
[in]old_polygon_shading_groupsThe polygon shading group of the original mesh
[out]new_facesThe new indices of the vertices per faces
[out]polygon_shading_groupsThe new values of the polygon shading group
[out]polygon_vertices_countThe new count of polygon per polygon
Core128BitHashKey OsdMesh::get_hash_key ( ) const
overridevirtual

Get the hash key of the resource.

Returns
the hash key

Reimplemented from ResourceData.

size_t OsdMesh::get_memory_size ( void  ) const
overridevirtual

Get the amount of memory occupied by the resource.

Returns an estimate in bytes of the data allocated by the object.

Reimplemented from ResourceData.

const GeometryPointCloud * OsdMesh::get_point_cloud ( ) const
overridevirtual

Get the point cloud defined by the geometry.

Returns
the point cloud or null if there's none
Note
The point cloud contains the list of all vertices with some associated properties.

Reimplemented from GeometryObject.

unsigned int OsdMesh::get_polygon_count ( ) const

Get the number of polygons that were used to build the mesh.

Returns
the number of polygons
void OsdMesh::get_polygon_shading_groups ( CoreArray< unsigned int > &  polygon_shading_groups) const

Get the shading group IDs for each polygon.

Parameters
[out]polygon_shading_groupsthe list of shading group IDs
void OsdMesh::get_polygon_vertex_count ( CoreArray< unsigned int > &  polygon_vertex_count) const

Get the array of vertex count for all polygons.

Parameters
[out]poylgon_vertex_countthe list of vertex count
void OsdMesh::get_polygon_vertex_indices ( CoreArray< unsigned int > &  polygon_vertex_indices) const

Get the list of vertex indices that define all polygons.

Parameters
[out]polygon_vertex_indicesthe list of vertex indices
Note
Polygons are following each others, there are no seperator in the list. The number of index for each polygon can be known with the get_polygon_vertex_count() method.
unsigned int OsdMesh::get_primitive_count ( ) const
overridevirtual

Get the number of primitives in the geometry.

Returns
the number of primitives

Implements GeometryObject.

unsigned int OsdMesh::get_primitive_edge_count ( const unsigned int &  id) const
overridevirtual

Get the number of edges of a primitive.

Parameters
[in]idthe ID of the primitive
Returns
the number of edges for the given primitive

Implements GeometryObject.

void OsdMesh::get_primitive_indices ( CoreArray< unsigned int > &  indices) const
overridevirtual

Get the list of vertex indices that define all primitives.

Parameters
[out]indicesthe list of vertex indices
Note
Primitives are following each others, there are no seperator in the list. The number of index for each primitive can be known with the get_primitive_edge_count() method.

Reimplemented from GeometryObject.

unsigned int OsdMesh::get_primitive_polygon_id ( const unsigned int &  id) const

Get the ID of the original polygon from which the primitive has been created.

Returns
the ID of the original polygon
unsigned int OsdMesh::get_primitive_shading_group_index ( const unsigned int &  id) const
overridevirtual

Get the ID of the shading group to which belongs a primitive.

Parameters
[in]idthe ID of the primitive
Returns
the ID of the shading group

Implements GeometryObject.

GMathBbox3d OsdMesh::get_shading_group_bbox ( const unsigned int &  id) const
overridevirtual

Get the bounding box of a shading group.

Parameters
[in]idthe ID of the shading group
Returns
the bounding box of the shading group

Reimplemented from GeometryObject.

const CoreBasicArray< CoreString > & OsdMesh::get_shading_group_names ( ) const
overridevirtual

Get the list of shading groups defined in the geometry.

Returns
the array of shading group names

Implements GeometryObject.

unsigned int OsdMesh::get_uv_map_count ( ) const
overridevirtual

Get the number of UV maps defined in the geometry.

Returns
the number of UV maps

Reimplemented from GeometryObject.

bool OsdMesh::get_uv_map_data ( const unsigned int &  uv_map_index,
CoreArray< GMathVec3f > &  uvs,
CoreArray< unsigned int > &  indices 
) const
overridevirtual

Get the data of a UV map.

Parameters
[in]uv_map_indexthe ID of the UV map
[out]uvsthe array of UVs
[out]indicesthe indices to the UVs for each primitive
Returns
true if the data for the UV map can be retrieved, else false

Reimplemented from GeometryObject.

const CoreString & OsdMesh::get_uv_map_name ( const unsigned int &  uv_map_index) const
overridevirtual

Get the name of a UV map.

Parameters
[in]uv_map_indexthe ID of the UV map
Returns
the name of the UV map

Reimplemented from GeometryObject.

unsigned int OsdMesh::get_vertex_count ( ) const
overridevirtual

Get the number of vertices in the geometry.

Returns
the number of vertices

Reimplemented from GeometryObject.

void OsdMesh::intersect_primitive ( const CtxEval eval_ctx,
const unsigned int &  id,
GeometryRaytraceCtx raytrace_ctx 
) const
overridevirtual

Compute the list of intersections between rays and a primitive.

Parameters
[in]eval_ctxa valid evaluation context
[in]idthe ID of the primitive
[in,out]raytrace_ctxthe context containing rays information and output results

Implements GeometryObject.

void OsdMesh::intersect_primitive ( const CtxEval eval_ctx,
const unsigned int &  id,
GeometryFrustumCtx frustum_ctx 
) const
overridevirtual

Compute the intersection between a frustum and a primitive.

Parameters
[in]eval_ctxa valid evaluation context
[in]idthe ID of the primitive
[in,out]frustum_ctxthe context containing the frustum information and the output result

Reimplemented from GeometryObject.

bool OsdMesh::is_animated ( ) const
overridevirtual

Indicate if the geometry has an animation for the current frame.

Returns
true if the geometry is animated, else false

Reimplemented from GeometryObject.

virtual bool OsdMesh::is_geometry_linear ( ) const
inlineoverridevirtual

Tell if the geometry is linear.

Returns
true if the geometry is linear, else false

Reimplemented from GeometryObject.

virtual bool OsdMesh::is_primitive_edge_linear ( const unsigned int &  primitive_index,
const unsigned int &  edge_index 
) const
inlineoverridevirtual

Tell if an edge on a primitive is linear.

Parameters
[in]primitive_indexthe ID of the primitive to which the edge belongs
[in]edge_indexthe ID of the edge in the primitive
Returns
true if the edge is linear, else false

Reimplemented from GeometryObject.

bool OsdMesh::is_primitive_edge_visible ( const unsigned int &  primitive_index,
const unsigned int &  edge_index 
) const
overridevirtual

Tell if an edge is visible.

Parameters
[in]primitive_indexthe ID of the primitive to which the edge belongs
[in]edge_indexthe ID of the edge in the primitive
Returns
true if the edge is visible, else false

Reimplemented from GeometryObject.

virtual bool OsdMesh::is_primitive_linear ( const unsigned int &  primitive_index) const
inlineoverridevirtual

Tell if a primitive is linear.

Parameters
[in]primitive_indexthe ID of the primitive
Returns
true if the primitive is linear, else false

Reimplemented from GeometryObject.

bool OsdMesh::is_primitive_uv_mapped ( const unsigned int &  primitive_id,
const unsigned int &  uv_map_index 
) const
overridevirtual

Tell if a primitive has a representation in a UV map.

Parameters
[in]primitive_idthe ID of the primitive
Returns
true if the primitive if mapped, else false

Reimplemented from GeometryObject.

void OsdMesh::set ( const CoreBasicArray< GMathVec3f > &  vertices,
const CoreBasicArray< GMathVec3f > &  velocities,
const CoreBasicArray< unsigned int > &  polygon_indices,
const CoreBasicArray< unsigned int > &  polygon_vertex_count,
const CoreBasicArray< unsigned int > &  polygon_shading_groups,
const CoreBasicArray< CoreString > &  shading_group_names,
const CoreBasicArray< GeometryUvMap > &  uv_maps,
const CoreBasicArray< GeometryColorMap > &  color_maps,
const unsigned int  level_subdivision,
const OsdMeshTopology osd_mesh_topology,
const OsdMeshMaps osd_mesh_maps,
AppProgressBar progress_bar = 0 
)

Build the mesh from external data.

Parameters
verticeslist of vertices of the geometry
velocitieslist of velocity values for each vertex (it corresponds to the position delta between 2 frames)
polygon_vertex_indiceslist of vertex indices for all polygons of the geometry
polygon_vertex_countnumber of vertices for each polygon of the geometry
polygon_shading_groupsshading group index for each polygon
shading_group_namesshading group names
uv_mapslist of UV maps
color_mapslist of color maps
progress_bara progress bar to know the progress (optional)
Note
The resulting number of primitives is not necessarily the same as the number of polygons. Triangles and quads are kept and all polygons with more than 4 edges are triangulated.
bool OsdMesh::set_point_cloud ( const GeometryPointCloud point_cloud,
AppProgressBar progress_bar = 0 
)
overridevirtual

Replace the point cloud.

Parameters
[in]point_cloudthe new point cloud
[in]progress_bara progress bar (optional)
Returns
true on success (the point cloud must be compatible, i.e. it must contain the same number of vertices), else false

Reimplemented from GeometryObject.

void OsdMesh::set_primitive_edge_visibility ( const unsigned int &  primitive_index,
const unsigned int &  edge_index,
const bool &  is_visible 
)

Set the visibility of an edge.

Parameters
primitive_indexthe index of the primitive
edge_indexthe index of the edge on the primitive
is_visibletrue if the edge must be visible, else false
void OsdMesh::set_subdivide ( unsigned int  subdivision_level,
OsdMeshTopology osd_mesh_topology,
const OsdMeshGeometry original_geometry,
OsdMeshMaps osd_mesh_maps,
AppProgressBar progress_bar,
AppProgressBar progress_bar_osd 
)

Set the parameters to do the subdivision.

Parameters
[in]subdivision_levelIt's the level of the subdivision
[in]osd_mesh_topologyIt contains the topology's information of the original mesh
[in]osd_mesh_geometryIt contains the geometry's information of the original mesh
[in]osd_mesh_mapsIt contains the map's information of the original mesh
[in]progress_barIt is a progress bar for the open subdiv subdivision
[in]progress_barIt is a progress bar for the creation and refinement of a opensubdiv's refiner
void OsdMesh::update_subdivide ( const OsdMeshGeometry osd_mesh_geometry,
const OsdMeshMaps osd_mesh_maps,
OsdMesh open_subdiv_res 
)

Update the values of the subdivision with the new informations.

Parameters
[in]osd_mesh_geometryIt contains the new geometry's information of the original mesh
[in]osd_mesh_mapsIt contains the new map's information of the original mesh
[out]open_subdiv_resIt contains the resulting mesh