< Home

< Table of Contents

REFERENCE MANUAL

TreeContext Class Reference

#include <hps.h>

Inheritance diagram for TreeContext:
Object

Public Member Functions

bool Equals (TreeContext const &in_that) const
 
Type ObjectType () const
 
bool operator!= (TreeContext const &in_that) const
 
TreeContextoperator= (TreeContext &&in_that)
 
TreeContextoperator= (TreeContext const &in_that)
 
bool operator== (TreeContext const &in_that) const
 
 TreeContext (bool in_create=true)
 
 TreeContext (TreeContext const &in_that)
 
 TreeContext (TreeContext &&in_that)
 
virtual ~TreeContext ()
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The TreeContext class is a user space object. It contains a spatial partition used for selection and relation computations with shells. If many world-space selections are going to be computed without modifying the segment tree, using the same tree context for all of them can be a significant optimization. If one is not specified, a new one is computed internally each time.

Constructor & Destructor Documentation

TreeContext::TreeContext ( bool  in_create = true)

The default constructor creates a new TreeContext object.

Parameters
in_createwhether to create the underlying spatial tree context.
TreeContext::TreeContext ( TreeContext const &  in_that)

The copy constructor shares a TreeContext object.

Parameters
in_thatThe source TreeContext to share.
TreeContext::TreeContext ( TreeContext &&  in_that)

The move constructor creates a new TreeContext by transferring the underlying impl of the rvalue reference to this TreeContext thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a TreeContext to take the impl from.
virtual TreeContext::~TreeContext ( )
virtual

The destructor cleans up the tree context created by the constructor.

Member Function Documentation

bool TreeContext::Equals ( TreeContext const &  in_that) const

Check if the source TreeContext is the same as this TreeContext.

Parameters
in_kitThe source TreeContext to compare to this TreeContext.
Returns
true if the objects are identical, false otherwise.
Type TreeContext::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from Object.

bool TreeContext::operator!= ( TreeContext const &  in_that) const

Check if the source TreeContext is not the same as this TreeContext.

Parameters
in_kitThe source TreeContext to compare to this TreeContext.
Returns
true if the objects are not identical, false otherwise.
TreeContext& TreeContext::operator= ( TreeContext &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this TreeContext thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a TreeContext to take the impl from.
Returns
A reference to this TreeContext.
TreeContext& TreeContext::operator= ( TreeContext const &  in_that)

Shares the source TreeContext.

Parameters
in_kitThe source TreeContext to share.
Returns
A reference to this TreeContext.
bool TreeContext::operator== ( TreeContext const &  in_that) const

Check if the source TreeContext is the same as this TreeContext.

Parameters
in_kitThe source TreeContext to compare to this TreeContext.
Returns
true if the objects are identical, false otherwise.

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