Box compound object class. More...

#include <Context.h>

Inheritance diagram for helios::Box:

Public Member Functions
	~Box () override=default
	Box destructor.

helios::vec3	getSize () const
	Get the dimensions of the box object in each Cartesian direction.

helios::vec3	getCenter () const
	Get the Cartesian coordinates of the center of the box object.

helios::int3	getSubdivisionCount () const
	Get the number of sub-patch divisions of the box object in each Cartesian direction.

void	setSubdivisionCount (const helios::int3 &subdiv)
	Set the number of box sub-patch divisions.

float	getVolume () const
	Get the volume of the box object.

Public Member Functions inherited from helios::CompoundObject
virtual	~CompoundObject ()=0
	Destructor.

uint	getObjectID () const
	Get the unique identifier for the object.

helios::ObjectType	getObjectType () const
	Get an enumeration specifying the type of the object.

uint	getPrimitiveCount () const
	Return the number of primitives contained in the object.

std::vector< uint >	getPrimitiveUUIDs () const
	Get the UUIDs for all primitives contained in the object.

bool	doesObjectContainPrimitive (uint UUID)
	Check whether a primitive is a member of the object based on its UUID.

helios::vec3	getObjectCenter () const
	Calculate the Cartesian (x,y,z) point of the center of a bounding box for the Compound Object.

float	getArea () const
	Calculate the total one-sided surface area of the Compound Object.

void	setColor (const helios::RGBcolor &color)
	Method to set the diffuse color for all primitives in the Compound Object.

void	setColor (const helios::RGBAcolor &color)
	Method to set the diffuse color (with transparency) for all primitives in the Compound Object.

void	overrideTextureColor ()
	Override the color in the texture map for all primitives in the Compound Object, in which case the primitives will be colored by the constant RGB color, but will apply the transparency channel in the texture to determine its shape.

void	useTextureColor ()

bool	hasTexture () const
	Method to check whether this object has texture data.

std::string	getTextureFile () const
	Method to return the texture map file of an Object.

void	translate (const helios::vec3 &shift)
	Method to translate/shift a Compound Object.

void	rotate (float rotation_radians, const char *rotation_axis_xyz_string)
	Method to rotate a Compound Object about the x-, y-, or z-axis.

void	rotate (float rotation_radians, const helios::vec3 &rotation_axis_vector)
	Method to rotate a Compound Object about an arbitrary axis passing through the origin.

void	rotate (float rotation_radians, const helios::vec3 &origin, const helios::vec3 &rotation_axis_vector)
	Method to rotate a Compound Object about an arbitrary line (not necessarily passing through the origin)

void	scale (const helios::vec3 &scale)
	Method to scale a compound object in the x-, y- and z-directions.

void	scaleAboutCenter (const helios::vec3 &scale)
	Method to scale a compound object in the x-, y- and z-directions.

void	scaleAboutPoint (const helios::vec3 &scale, const helios::vec3 &point)
	Method to scale a compound object in the x-, y- and z-directions.

void	getTransformationMatrix (float(&T)[16]) const
	Method to return the Affine transformation matrix of a Compound Object.

void	setTransformationMatrix (float(&T)[16])
	Method to set the Affine transformation matrix of a Compound Object.

void	setPrimitiveUUIDs (const std::vector< uint > &UUIDs)
	Method to set the UUIDs of object child primitives.

void	deleteChildPrimitive (uint UUID)
	Delete a single child member of the object.

void	deleteChildPrimitive (const std::vector< uint > &UUIDs)
	Delete multiple child member of the object based on a vector of UUIDs.

bool	arePrimitivesComplete () const
	Method to query whether all object primitives are intact.

template<typename T >
void	setObjectData (const char *label, const T &data)
	Add data value associated with a compound object.

template<typename T >
void	setObjectData (const char *label, const std::vector< T > &data)
	Add data value associated with a compound object.

template<typename T >
void	getObjectData (const char *label, T &data) const
	Get data associated with a compound object.

template<typename T >
void	getObjectData (const char *label, std::vector< T > &data) const
	Get vector data associated with a compound object.

HeliosDataType	getObjectDataType (const char *label) const
	Get the Helios data type of object data.

uint	getObjectDataSize (const char *label) const
	Get the size/length of object data.

bool	doesObjectDataExist (const char *label) const
	Check if object data 'label' exists.

void	clearObjectData (const char *label)
	Clear the object data for this object.

std::vector< std::string >	listObjectData () const
	Return labels for all object data for this particular object.

Friends
class	CompoundObject

class	Context

Detailed Description

Box compound object class.

Definition at line 853 of file Context.h.

Member Function Documentation

◆ getCenter()

vec3 Box::getCenter ( ) const

Get the Cartesian coordinates of the center of the box object.

Definition at line 2413 of file Context_object.cpp.

◆ getSize()

vec3 Box::getSize ( ) const

Get the dimensions of the box object in each Cartesian direction.

Definition at line 2396 of file Context_object.cpp.

◆ getSubdivisionCount()

helios::int3 Box::getSubdivisionCount ( ) const

Get the number of sub-patch divisions of the box object in each Cartesian direction.

Definition at line 2427 of file Context_object.cpp.

◆ getVolume()

float Box::getVolume ( ) const

Get the volume of the box object.

Definition at line 2435 of file Context_object.cpp.

◆ setSubdivisionCount()

void Box::setSubdivisionCount ( const helios::int3 & subdiv )

Set the number of box sub-patch divisions.

Parameters

[in] subdiv Number of patch subdivisions in each direction.

Definition at line 2431 of file Context_object.cpp.

Friends And Related Symbol Documentation

◆ CompoundObject

friend class CompoundObject

friend

Definition at line 885 of file Context.h.

◆ Context

friend class Context