1.3.49
 
Loading...
Searching...
No Matches
helios::Tile Class Referencefinal

Tile compound object class. More...

#include <Context.h>

Inheritance diagram for helios::Tile:
helios::CompoundObject

Public Member Functions

 ~Tile () override=default
 Tile destructor.
 
helios::vec2 getSize () const
 Get the dimensions of the entire tile object.
 
helios::vec3 getCenter () const
 Get the Cartesian coordinates of the center of the tile object.
 
helios::int2 getSubdivisionCount () const
 Get the number of sub-patch divisions of the tile.
 
void setSubdivisionCount (const helios::int2 &subdiv)
 Set the number of tile sub-patch divisions.
 
std::vector< helios::vec3getVertices () const
 Get the Cartesian coordinates of each of the four corners of the tile object.
 
helios::vec3 getNormal () const
 Get a unit vector normal to the tile object surface.
 
std::vector< helios::vec2getTextureUV () const
 Get the normalized (u,v) coordinates of the texture at each of the four corners of the tile 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< uintgetPrimitiveUUIDs () 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

Tile compound object class.

Definition at line 665 of file Context.h.

Member Function Documentation

◆ getCenter()

vec3 Tile::getCenter ( ) const

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

Definition at line 1747 of file Context_object.cpp.

◆ getNormal()

vec3 Tile::getNormal ( ) const

Get a unit vector normal to the tile object surface.

Definition at line 1797 of file Context_object.cpp.

◆ getSize()

helios::vec2 Tile::getSize ( ) const

Get the dimensions of the entire tile object.

Definition at line 1740 of file Context_object.cpp.

◆ getSubdivisionCount()

helios::int2 Tile::getSubdivisionCount ( ) const

Get the number of sub-patch divisions of the tile.

Definition at line 1762 of file Context_object.cpp.

◆ getTextureUV()

std::vector< helios::vec2 > Tile::getTextureUV ( ) const

Get the normalized (u,v) coordinates of the texture at each of the four corners of the tile object.

Definition at line 1801 of file Context_object.cpp.

◆ getVertices()

std::vector< helios::vec3 > Tile::getVertices ( ) const

Get the Cartesian coordinates of each of the four corners of the tile object.

Definition at line 1771 of file Context_object.cpp.

◆ setSubdivisionCount()

void Tile::setSubdivisionCount ( const helios::int2 subdiv)

Set the number of tile sub-patch divisions.

Parameters
[in]subdivNumber of subdivisions in x- and y-directions.
Note
This will delete all prior child primitives and add new UUIDs

Definition at line 1766 of file Context_object.cpp.

Friends And Related Symbol Documentation

◆ CompoundObject

friend class CompoundObject
friend

Definition at line 704 of file Context.h.

◆ Context

friend class Context
friend

Definition at line 705 of file Context.h.


The documentation for this class was generated from the following files: