Cogs::Core::ZipComponent Struct Reference

Component displaying a 3D log on a trajectory. More...

#include <ZipComponent.h>

Inheritance diagram for Cogs::Core::ZipComponent:

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::shared_ptr< ComponentModel::Entity >	extrusion
	Wellbore entity owning.
std::shared_ptr< ComponentModel::Entity >	dataSet
	Dataset entity with log depths and values.
std::shared_ptr< ComponentModel::Entity >	colorMap
	Colormap entity to map Dataset values to colors.
std::shared_ptr< ComponentModel::Entity >	highlightTarget
	Optional Highlighting entity.
float	highlightStart = 0.f
	Start position (depth) of highlighting.
float	highlightEnd = 0.f
	End position (depth) of highlighting.
glm::vec3	axis = glm::vec3(1,0,0)
	Axis determining direction of 3D log (=1,0,0).
bool	rotateAxisToCamera = true
float	scale = 1.f
	Scaling of value axis (=1).
bool	enableFill = true
	Fill area between log curve and extrusion.
bool	enableOutline = true
	Mark outline of curve.
bool	useTrajectoryOrientedAxis = false
bool	active = true
	Enable/disable display of log.

Additional Inherited Members
Public Member Functions inherited from Cogs::ComponentModel::Component
class Entity *	getContainer () 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 Component *	getComponent (const Reflection::Name &name) const
COGSFOUNDATION_API Component *	getComponent (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::Type &	getType () 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

Component displaying a 3D log on a trajectory.

Typical usage a Well Log on Well Trajectory.

Definition at line 16 of file ZipComponent.h.

Member Function Documentation

registerType()

void Cogs::Core::ZipComponent::registerType ( )

static

Definition at line 7 of file ZipComponent.cpp.

Member Data Documentation

active

bool Cogs::Core::ZipComponent::active = true

Enable/disable display of log.

Definition at line 55 of file ZipComponent.h.

axis

glm::vec3 Cogs::Core::ZipComponent::axis = glm::vec3(1,0,0)

Axis determining direction of 3D log (=1,0,0).

Definition at line 37 of file ZipComponent.h.

colorMap

std::shared_ptr<ComponentModel::Entity> Cogs::Core::ZipComponent::colorMap

Colormap entity to map Dataset values to colors.

Definition at line 25 of file ZipComponent.h.

dataSet

std::shared_ptr<ComponentModel::Entity> Cogs::Core::ZipComponent::dataSet

Dataset entity with log depths and values.

Definition at line 22 of file ZipComponent.h.

enableFill

bool Cogs::Core::ZipComponent::enableFill = true

Fill area between log curve and extrusion.

Definition at line 47 of file ZipComponent.h.

enableOutline

bool Cogs::Core::ZipComponent::enableOutline = true

Mark outline of curve.

Definition at line 50 of file ZipComponent.h.

extrusion

std::shared_ptr<ComponentModel::Entity> Cogs::Core::ZipComponent::extrusion

Wellbore entity owning.

See also

ExtrusionComponent trajectory and.

Definition at line 19 of file ZipComponent.h.

highlightEnd

float Cogs::Core::ZipComponent::highlightEnd = 0.f

End position (depth) of highlighting.

Definition at line 34 of file ZipComponent.h.

highlightStart

float Cogs::Core::ZipComponent::highlightStart = 0.f

Start position (depth) of highlighting.

Definition at line 31 of file ZipComponent.h.

highlightTarget

std::shared_ptr<ComponentModel::Entity> Cogs::Core::ZipComponent::highlightTarget

Optional Highlighting entity.

Definition at line 28 of file ZipComponent.h.

rotateAxisToCamera

bool Cogs::Core::ZipComponent::rotateAxisToCamera = true

Rotate axis of 3D log when camera moves (=true). Axis = (0,1,0) is facing camera. For a horizontal well disable rotateAxisToCamera. A good axis is perpendicular to direction of horizontal part of well.

Definition at line 41 of file ZipComponent.h.

scale

float Cogs::Core::ZipComponent::scale = 1.f

Scaling of value axis (=1).

Definition at line 44 of file ZipComponent.h.

useTrajectoryOrientedAxis

bool Cogs::Core::ZipComponent::useTrajectoryOrientedAxis = false

Definition at line 52 of file ZipComponent.h.

---

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

• Extensions/WellLog/Source/Components/ZipComponent.h
• Extensions/WellLog/Source/Components/ZipComponent.cpp