Cogs.Core
Static Public Member Functions | Public Attributes | List of all members
Cogs::Core::OGC3DTilesComponent Struct Reference
Inheritance diagram for Cogs::Core::OGC3DTilesComponent:
Cogs::ComponentModel::Component

Static Public Member Functions

static void registerType ()
 
- Static Public Member Functions inherited from Cogs::ComponentModel::Component
static COGSFOUNDATION_API void registerType ()
 Register the Component type in the global type database.
 
static COGSFOUNDATION_API Reflection::TypeId getComponentTypeId (const StringView &name)
 Get the type id of the component type with the given name.
 

Public Attributes

std::string baseURL
 
std::string additionalURLParameters
 
float detailFactor = 1.0
 
bool showTileBBoxes = false
 
bool neverDiscardRootTiles = true
 
bool waitForTileSiblings = true
 
bool enableCaching = false
 
MaterialInstanceHandle overrideMaterial
 
std::string accessToken
 
int assetId = -1
 
bool dontRenderLeaves = false
 

Additional Inherited Members

- Public Member Functions inherited from Cogs::ComponentModel::Component
class EntitygetContainer () const
 Get the container currently owning this component instance.
 
void setContainer (class Entity *container)
 Set the container owning this component instance.
 
template<typename ComponentType >
ComponentType * getComponent () const
 
COGSFOUNDATION_API ComponentgetComponent (const Reflection::Name &name) const
 
COGSFOUNDATION_API ComponentgetComponent (const Reflection::TypeId &id) const
 
template<typename ComponentType >
ComponentHandle getComponentHandle () const
 
COGSFOUNDATION_API ComponentHandle getComponentHandle (const Reflection::Name &name) const
 
COGSFOUNDATION_API ComponentHandle getComponentHandle (const Reflection::TypeId &id) const
 
void setActive ()
 Sets the component to the ComponentFlags::Active state.
 
bool isActive () const
 Gets if the component is currently set to the ComponentFlags::Active state.
 
void setChanged ()
 Sets the component to the ComponentFlags::Changed state with carry.
 
void setChangedTransient ()
 Sets the component to the ComponentFlags::Changed state without carry.
 
void setFieldChanged (const Reflection::FieldId fieldId)
 Sets the component to the ComponentFlags::Changed state without carry.
 
template<typename ClassType , typename FieldType >
void setFieldChanged (FieldType ClassType::*field)
 Sets a flag indicating that the given field has changed.
 
void setFieldChangedTransient (const Reflection::FieldId fieldId)
 Sets the component to the ComponentFlags::Changed state without carry.
 
bool hasChanged () const
 
bool hasAnyfieldChanged () const
 Gets if any fields have been changed.
 
bool hasFieldChanged (const Reflection::FieldId fieldId) const
 Gets if the field with the given id on this component instance has changed.
 
template<typename ClassType , typename FieldType >
bool hasFieldChanged (FieldType ClassType::*field) const
 Gets if the given field has changed.
 
void resetCarryChanged ()
 Reset the CarryChanged flag. Called at start of redraw. See ComponentFlags::CarryChanged.
 
void resetChanged ()
 Resets the changed state of the component, respecting any carry state set.
 
template<typename ClassType , typename FieldType >
Reflection::FieldId getFieldId (FieldType ClassType::*field) const
 Gets field ID of the given field.
 
void resetFieldsChanged ()
 Resets the state of all changed field flags.
 
void resetFieldChanged (const Reflection::FieldId fieldId)
 Resets the changed state of the given fieldId.
 
template<typename ClassType , typename FieldType >
void resetFieldChanged (FieldType ClassType::*field)
 Resets the changed state of the given field.
 
constexpr void setFlags (const uint32_t flags)
 Override all flags of the Component, setting the given flags.
 
constexpr void setFlag (const uint32_t flag)
 Set the given flags. Does not override the currently set flags.
 
constexpr void unsetFlag (const uint32_t flag)
 Unset the given flag. Does not remove the status of other than the given flags.
 
constexpr bool isSet (const uint32_t flag) const
 Checks if the given flag is set. Requires exact bit match if test of several bits.
 
constexpr void setTypeId (const Reflection::TypeId typeId)
 Set the Reflection::TypeId of the component.
 
constexpr Reflection::TypeId getTypeId () const
 Get the Reflection::TypeId of the component.
 
COGSFOUNDATION_API const Reflection::TypegetType () const
 Get the full Reflection::Type of the component.
 
constexpr void setIndex (const ComponentIndex index)
 Set the components pool index. For internal use only.
 
constexpr ComponentIndex getIndex () const
 Get the components pool index. For internal use only.
 
constexpr void setGeneration (uint16_t generation)
 Sets the component generation.
 
constexpr uint16_t getGeneration () const
 Gets the component generation.
 
size_t hash (size_t hashValue=Cogs::hash()) const
 Calculates a hash of this component's members.
 

Detailed Description

Definition at line 25 of file OGC3DTilesComponent.h.

Member Function Documentation

◆ registerType()

void Cogs::Core::OGC3DTilesComponent::registerType ( )
static

Definition at line 8 of file OGC3DTilesComponent.cpp.

Member Data Documentation

◆ accessToken

std::string Cogs::Core::OGC3DTilesComponent::accessToken

Optional: Some servers requires an access-token to perform the authentication to fetch assets-info.

Definition at line 86 of file OGC3DTilesComponent.h.

◆ additionalURLParameters

std::string Cogs::Core::OGC3DTilesComponent::additionalURLParameters

Optional: Additional URL parameters which will be added to all tileset.json requests (not content or subtree requests). Each parameter must be separated by an '&'. Do not add the '?' prefix.

Definition at line 38 of file OGC3DTilesComponent.h.

◆ assetId

int Cogs::Core::OGC3DTilesComponent::assetId = -1

Optional: Some servers require an asset-id to select the correct dataset. The entire assets-mechanism will be bypassed if assetId is -1.

Definition at line 92 of file OGC3DTilesComponent.h.

◆ baseURL

std::string Cogs::Core::OGC3DTilesComponent::baseURL

The base URL for the OGC 3DTiles dataset. Must at least contain a "tileset.json" file.

Definition at line 32 of file OGC3DTilesComponent.h.

Referenced by Cogs::Core::OGC3DTilesSystem::destroyComponent().

◆ detailFactor

float Cogs::Core::OGC3DTilesComponent::detailFactor = 1.0

How much details we shall fetch depending on the tile's distance to the camera. Higher -> More details.

Definition at line 43 of file OGC3DTilesComponent.h.

◆ dontRenderLeaves

bool Cogs::Core::OGC3DTilesComponent::dontRenderLeaves = false

Optional: Don't render leaf nodes. Some converters (e.g. CesiumION) might introduce an abrupt visual change between a leaf and it's parent (usually in the form of materal change or a large difference in triangle-resolution). Use this switch if this is an issue.

NOTE 1: If any child of a node is a leaf-node then none of the children will be rendered, only the parent due to how oct/quad-trees work. This option might therefore prevent a lot of high detailed nodes from being loaded because a leaf-node was placed high in the tree.

NOTE 2: This feature might not work nice with tilesets with layers of "to be scheduled" sub-tilesets.

Definition at line 105 of file OGC3DTilesComponent.h.

◆ enableCaching

bool Cogs::Core::OGC3DTilesComponent::enableCaching = false

Optional: Enable caching. The system will not release tiles outside the view-frustum unless the "QualityService" reports a drop in quality. The "quality.GPUMemTargetMB" context-variable must be set to a non-zero value. Be aware that this will increase memory usage.

Definition at line 74 of file OGC3DTilesComponent.h.

◆ neverDiscardRootTiles

bool Cogs::Core::OGC3DTilesComponent::neverDiscardRootTiles = true

Never remove visited root nodes from memory.

Definition at line 53 of file OGC3DTilesComponent.h.

◆ overrideMaterial

MaterialInstanceHandle Cogs::Core::OGC3DTilesComponent::overrideMaterial

Optional: Global override-material which will be applied to all tiles. Please note that there are limits to what makes sense for a global override-material. Textures and other features which requires individual data-arrays will not work.

Definition at line 81 of file OGC3DTilesComponent.h.

◆ showTileBBoxes

bool Cogs::Core::OGC3DTilesComponent::showTileBBoxes = false

Render overlay bbox indicators for each tile.

Definition at line 48 of file OGC3DTilesComponent.h.

◆ waitForTileSiblings

bool Cogs::Core::OGC3DTilesComponent::waitForTileSiblings = true

Do not render child-tiles until all siblings are loaded and ready. Render parent tiles while waiting.

When FALSE; all leaf nodes will be rendered as soon as they are ready. This may cause temprorary "holes" in the geometry but the popping down to a lower LOD level while loading siblings will be greatly reduced. Please note that a low value of the context variable "maxNumberOfConcurrentRequests" will increase the risk of holes in the geometry.

NOTE: This setting will have no effect if the tileset is of type "refinement=ADD".

Definition at line 66 of file OGC3DTilesComponent.h.


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