Interface representing a freeform surface. More...

#include <ifreeform_surface.h>

Inheritance diagram for mi::neuraylib::IFreeform_surface:

[legend]

Public Member Functions
Methods related to surfaces
virtual Uint32	get_surfaces_size () const =0
	Returns the number of surfaces. More...

virtual ISurface *	add_surface ()=0
	Adds and returns a new surface. More...

virtual const ISurface *	access_surface (Surface_handle_struct s) const =0
	Returns a surface (const). More...

virtual ISurface *	edit_surface (Surface_handle_struct s)=0
	Returns a surface (mutable). More...

virtual Sint32	remove_surface (Surface_handle_struct s)=0
	Removes a surface. More...

Methods related to per-primitive attributes
virtual bool	has_attribute (Mesh_attribute_name name) const =0
	Indicates whether the freeform surface has a particular mesh attribute. More...

virtual IAttribute_vector *	create_attribute_vector (Mesh_attribute_name name, Uint32 dim=1)=0
	Creates a per-primitive mesh attribute. More...

virtual const IAttribute_vector *	access_attribute_vector (Mesh_attribute_name name) const =0
	Returns a per-primitive mesh attribute. More...

virtual IAttribute_vector *	edit_attribute_vector (Mesh_attribute_name name)=0
	Detaches and returns a per-primitive mesh attribute. More...

virtual Sint32	attach_attribute_vector (IAttribute_vector *attribute_vector)=0
	Attaches a given per-primitive mesh attribute to the freeform surface. More...

virtual Sint32	remove_attribute_vector (Mesh_attribute_name name)=0
	Removes a per-primitive mesh attribute. More...

Methods related to the bounding box
virtual Bbox3_struct	get_bbox () const =0
	Returns the bounding box of the freeform surface. More...

virtual Bbox3_struct	get_tight_bbox (const Float64_4_4_struct &transformation_matrix) const =0
	Returns the bounding box of the freeform surface after transformation. More...

Methods related to displacement
virtual void	set_maximum_displacement (Float32 displacement)=0
	Sets the maximum displacement of the freeform surface. More...

virtual Float32	get_maximum_displacement () const =0
	Returns the maximum displacement of the freeform surface. More...

Public Member Functions inherited from mi::neuraylib::IScene_element
virtual Element_type	get_element_type () const =0
	Indicates the actual scene element represented by interfaces derived from this interface. More...

Public Member Functions inherited from mi::neuraylib::IAttribute_set
virtual IData *	create_attribute (const char name, const char type)=0
	Creates a new attribute `name` of the type `type`. More...

template<class T>
T *	create_attribute (const char name, const char type)
	Creates a new attribute `name` of the type `type`. More...

template<class T>
T *	create_attribute (const char *name)
	Creates a new attribute `name` of the type `T`. More...

virtual bool	destroy_attribute (const char *name)=0
	Destroys the attribute `name`. More...

virtual const IData *	access_attribute (const char *name) const =0
	Returns a const pointer to the attribute `name`. More...

template<class T>
const T *	access_attribute (const char *name) const
	Returns a const pointer to the attribute `name`. More...

virtual IData *	edit_attribute (const char *name)=0
	Returns a mutable pointer to the attribute `name`. More...

template<class T>
T *	edit_attribute (const char *name)
	Returns a mutable pointer to the attribute `name`. More...

virtual bool	is_attribute (const char *name) const =0
	Indicates existence of an attribute. More...

virtual const char *	get_attribute_type_name (const char *name) const =0
	Returns the type of an attribute. More...

virtual Sint32	set_attribute_propagation (const char *name, Propagation_type value)=0
	Sets the propagation type of the attribute `name`. More...

virtual Propagation_type	get_attribute_propagation (const char *name) const =0
	Returns the propagation type of the attribute `name`. More...

virtual const char *	enumerate_attributes (Sint32 index) const =0
	Returns the name of the attribute indicated by `index`. More...

Public Member Functions inherited from mi::base::IInterface
virtual Uint32	retain () const =0
	Increments the reference count. More...

virtual Uint32	release () const =0
	Decrements the reference count. More...

virtual const IInterface *	get_interface (const Uuid &interface_id) const =0
	Acquires a const interface from another. More...

template<class T>
const T *	get_interface () const
	Acquires a const interface from another. More...

virtual IInterface *	get_interface (const Uuid &interface_id)=0
	Acquires a mutable interface from another. More...

template<class T>
T *	get_interface ()
	Acquires a mutable interface from another. More...

virtual Uuid	get_iid () const =0
	Returns the interface ID of the most derived interface. More...

Additional Inherited Members
Public Types inherited from mi::base::Interface_declare< 0x5b54fda0, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::Interface_declare< 0x8a2a4da9, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::Interface_declare< 0x1bcb8d48, ... >
typedef Interface_declare< id1, ... >	Self
	Own type. More...

typedef Uuid_t< id1, ... >	IID
	Declares the interface ID (IID) of this interface. More...

Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0>	IID
	Declares the interface ID (IID) of this interface. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x5b54fda0, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x8a2a4da9, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::Interface_declare< 0x1bcb8d48, ... >
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface and of its ancestors. More...

Static Public Member Functions inherited from mi::base::IInterface
static bool	compare_iid (const Uuid &iid)
	Compares the interface ID `iid` against the interface ID of this interface. More...

Detailed Description

Interface representing a freeform surface.

Conceptually, a freeform surface object consists of several surfaces (see mi::neuraylib::ISurface). Due to a current limitation, only one surface is supported.

Surfaces are stored with consecutive indices, starting with the index 0. For type safety, surface indices are represented using mi::neuraylib::Surface_handle instead of plain integers.

In addition to regular attributes (see mi::neuraylib::IAttribute_set), freeform surfaces can also have mesh attributes. In contrast to regular attributes which exist only once per object, mesh attributes are always a vector of values with one vector element per primitive, per point, or per vertex (see mi::neuraylib::Mesh_attribute_name and mi::neuraylib::IAttribute_vector for details).

For freeform surfaces, only per-primitive mesh attributes are supported (the primitives are the the individual surfaces). Texture spaces are represented via so-called texture surfaces. Other per-point or per-vertex mesh attributes are not supported for freeform surfaces.

See also the "approx" and "approx_curve" attributes on mi::neuraylib::IAttribute_set for information how to control the tessellation of the freeform surface.

See also: mi::neuraylib::IAttribute_vector; mi::neuraylib::ISurface

Member Function Documentation

^◆ access_attribute_vector()

virtual const IAttribute_vector * mi::neuraylib::IFreeform_surface::access_attribute_vector ( Mesh_attribute_name name ) const

pure virtual

Returns a per-primitive mesh attribute.

See also: methods on mi::neuraylib::ISurface for texture spaces

Parameters

name	The name of the attribute, see Mesh_attribute_name. The attribute must be a per-primitive attribute.

Returns: The requested attribute vector, or NULL in case of failure.

^◆ access_surface()

virtual const ISurface * mi::neuraylib::IFreeform_surface::access_surface ( Surface_handle_struct s ) const

pure virtual

Returns a surface (const).

^◆ add_surface()

virtual ISurface * mi::neuraylib::IFreeform_surface::add_surface ( )

pure virtual

Adds and returns a new surface.

Note: Currently only one surface is supported.

^◆ attach_attribute_vector()

virtual Sint32 mi::neuraylib::IFreeform_surface::attach_attribute_vector ( IAttribute_vector * attribute_vector )

pure virtual

Attaches a given per-primitive mesh attribute to the freeform surface.

The attribute vector must not be used any longer after it has been attached.

See also: create_attribute_vector(), edit_attribute_vector()

Returns

0: Success.
-1: Invalid parameters (NULL pointer).
-2: The attribute vector has not been acquired from this freeform surface.
-3: The attribute vector is not a per-primitive attribute vector.
-4: The attribute vector is a per-primitive attribute vector and the number of elements does not match the number of surfaces of the freeform surface.
-5: An attribute of the same name is already attached to the freeform surface.

^◆ create_attribute_vector()

virtual IAttribute_vector * mi::neuraylib::IFreeform_surface::create_attribute_vector	(	Mesh_attribute_name	name,
		Uint32	dim = `1`
	)

pure virtual

Creates a per-primitive mesh attribute.

The attribute is not yet attached to the freeform surface. It needs to be attached before it is released.

Note: It is possible to create multiple attribute vectors on the same connectivity. If this connectivity is not the mesh connectivity, i.e., the attribute is not per point, but per vertex, then the connectivity information will eventually be duplicated such that each attribute vector has its own copy. This duplication happens after re-attaching the connectivity, but before it is stored in the database or the edit cycle ends.

See also: methods on mi::neuraylib::ISurface for texture spaces; attach_attribute_vector()

Parameters

name	The name of the attribute, see Mesh_attribute_name. The attribute must be a per-primitive attribute.
dim	Dimension of an attribute value. Only used for those attributes that have user specifiable dimensions.

Returns: The requested attribute vector, or NULL in case of failure.

^◆ edit_attribute_vector()

virtual IAttribute_vector * mi::neuraylib::IFreeform_surface::edit_attribute_vector ( Mesh_attribute_name name )

pure virtual

Detaches and returns a per-primitive mesh attribute.

The attribute needs to be reattached before it is released. Otherwise, the attribute is effectively removed from the freeform surface.

See also: methods on mi::neuraylib::ISurface for texture spaces; attach_attribute_vector()

Parameters

name	The name of the attribute, see Mesh_attribute_name. The attribute must be a per-primitive attribute.

Returns: The requested attribute vector, or NULL in case of failure.

^◆ edit_surface()

virtual ISurface * mi::neuraylib::IFreeform_surface::edit_surface ( Surface_handle_struct s )

pure virtual

Returns a surface (mutable).

^◆ get_bbox()

virtual Bbox3_struct mi::neuraylib::IFreeform_surface::get_bbox ( ) const

pure virtual

Returns the bounding box of the freeform surface.

^◆ get_maximum_displacement()

virtual Float32 mi::neuraylib::IFreeform_surface::get_maximum_displacement ( ) const

pure virtual

Returns the maximum displacement of the freeform surface.

See also: set_maximum_displacement()

^◆ get_surfaces_size()

virtual Uint32 mi::neuraylib::IFreeform_surface::get_surfaces_size ( ) const

pure virtual

Returns the number of surfaces.

^◆ get_tight_bbox()

virtual Bbox3_struct mi::neuraylib::IFreeform_surface::get_tight_bbox ( const Float64_4_4_struct & transformation_matrix ) const

pure virtual

Returns the bounding box of the freeform surface after transformation.

Parameters

transformation_matrix The world-to-object space transformation matrix that is applied to the object before the bounding box is computed.

^◆ has_attribute()

virtual bool mi::neuraylib::IFreeform_surface::has_attribute ( Mesh_attribute_name name ) const

pure virtual

Indicates whether the freeform surface has a particular mesh attribute.

Parameters

name	The name of the attribute to query, see Mesh_attribute_name.

Returns: true if the freeform surface has this attribute, false otherwise.

^◆ remove_attribute_vector()

virtual Sint32 mi::neuraylib::IFreeform_surface::remove_attribute_vector ( Mesh_attribute_name name )

pure virtual

Removes a per-primitive mesh attribute.

Parameters

name	The name of the attribute, see Mesh_attribute_name. The attribute must be a per-primitive attribute.

Returns

0: Success.
-1: There is no per-primitive attribute of the given name.

^◆ remove_surface()

virtual Sint32 mi::neuraylib::IFreeform_surface::remove_surface ( Surface_handle_struct s )

pure virtual

Removes a surface.

Note that the surface IDs of the following surfaces are decreased by 1.

^◆ set_maximum_displacement()

virtual void mi::neuraylib::IFreeform_surface::set_maximum_displacement ( Float32 displacement )

pure virtual

Sets the maximum displacement of the freeform surface.

This value is the maximum absolute value of any displacement applied to the object (defaults to 0.0). The bounding box of the object will be expanded all around by this value.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ access_attribute_vector()

◆ access_surface()

◆ add_surface()

◆ attach_attribute_vector()

◆ create_attribute_vector()

◆ edit_attribute_vector()

◆ edit_surface()

◆ get_bbox()

◆ get_maximum_displacement()

◆ get_surfaces_size()

◆ get_tight_bbox()

◆ has_attribute()

◆ remove_attribute_vector()

◆ remove_surface()

◆ set_maximum_displacement()

^◆ access_attribute_vector()

^◆ access_surface()

^◆ add_surface()

^◆ attach_attribute_vector()

^◆ create_attribute_vector()

^◆ edit_attribute_vector()

^◆ edit_surface()

^◆ get_bbox()

^◆ get_maximum_displacement()

^◆ get_surfaces_size()

^◆ get_tight_bbox()

^◆ has_attribute()

^◆ remove_attribute_vector()

^◆ remove_surface()

^◆ set_maximum_displacement()