Package gaiasky.util

Class CatalogInfo

java.lang.Object

gaiasky.util.CatalogInfo

public class CatalogInfo
extends Object

Saves the metadata on a particular catalog or dataset loaded into Gaia Sky, and implements some common operations like highlighting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CatalogInfo.CatalogInfoSource

Field Summary

Fields

Modifier and Type	Field	Description
String	description
com.badlogic.ashley.core.Entity	entity
Filter	filter
boolean	highlighted
boolean	hlAllVisible
float	hlCmapAlpha
IAttribute	hlCmapAttribute
int	hlCmapIndex
double	hlCmapMax
double	hlCmapMin
float[]	hlColor
float	hlSizeFactor
Instant	loadDateUTC
String	name
long	nParticles
boolean	plainColor
long	sizeBytes
String	source
CatalogInfo.CatalogInfoSource	type

Constructor Summary

Constructors

Constructor	Description
CatalogInfo(String name, String description, String source, CatalogInfo.CatalogInfoSource type, float hlSizeFactor)
CatalogInfo(String name, String description, String source, CatalogInfo.CatalogInfoSource type, float hlSizeFactor, com.badlogic.ashley.core.Entity entity)

Method Summary

Modifier and Type	Method	Description
ComponentTypes	getCt()	Gets the component type of the model object linked to this catalog.
float[]	getHlColor()
boolean	hasParticleAttributes()
void	highlight(boolean hl)	Highlight the dataset using the dataset's own color index
boolean	isHighlightable()
boolean	isParticleSet()
boolean	isStarSet()
boolean	isVisible()
boolean	isVisible(boolean attributeValue)
void	removeCatalog()	Unloads and removes the catalog described by this catalog info
void	setColor(float r, float g, float b, float a)
void	setEntity(com.badlogic.ashley.core.Entity entity)
void	setHlAllVisible(boolean allVisible)
void	setHlColor(float[] hlColor)
void	setHlColormap(int cmapIndex, IAttribute cmapAttribute, double cmapMin, double cmapMax)
void	setHlSizeFactor(float hlSizeFactor)
void	setVisibility(boolean visibility)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

public String name

description

public String description

source

public String source

nParticles

public long nParticles

sizeBytes

public long sizeBytes

loadDateUTC

public Instant loadDateUTC

highlighted

public boolean highlighted

plainColor

public boolean plainColor

hlColor

public float[] hlColor

hlSizeFactor

public float hlSizeFactor

hlAllVisible

public boolean hlAllVisible

hlCmapIndex

public int hlCmapIndex

hlCmapAlpha

public float hlCmapAlpha

hlCmapAttribute

public IAttribute hlCmapAttribute

hlCmapMin

public double hlCmapMin

hlCmapMax

public double hlCmapMax

filter

public Filter filter

type

public CatalogInfo.CatalogInfoSource type

entity

public com.badlogic.ashley.core.Entity entity

Constructor Details

CatalogInfo

public CatalogInfo(String name,
 String description,
 String source,
 CatalogInfo.CatalogInfoSource type,
 float hlSizeFactor,
 com.badlogic.ashley.core.Entity entity)

CatalogInfo

public CatalogInfo(String name,
 String description,
 String source,
 CatalogInfo.CatalogInfoSource type,
 float hlSizeFactor)

Method Details

setEntity

public void setEntity(com.badlogic.ashley.core.Entity entity)

setVisibility

public void setVisibility(boolean visibility)

isVisible

public boolean isVisible()

isVisible

public boolean isVisible(boolean attributeValue)

setColor

public void setColor(float r,
 float g,
 float b,
 float a)

getHlColor

public float[] getHlColor()

setHlColor

public void setHlColor(float[] hlColor)

setHlColormap

public void setHlColormap(int cmapIndex,
 IAttribute cmapAttribute,
 double cmapMin,
 double cmapMax)

setHlSizeFactor

public void setHlSizeFactor(float hlSizeFactor)

setHlAllVisible

public void setHlAllVisible(boolean allVisible)

removeCatalog

public void removeCatalog()

Unloads and removes the catalog described by this catalog info

highlight

public void highlight(boolean hl)

Highlight the dataset using the dataset's own color index

Parameters:

hl - Whether to highlight or not

isHighlightable

public boolean isHighlightable()

Returns:

True if this is a highlightable catalog, false otherwise.

hasParticleAttributes

public boolean hasParticleAttributes()

Returns:

True if this catalog's particles have attributes (they are stars), false otherwise.

isParticleSet

public boolean isParticleSet()

isStarSet

public boolean isStarSet()

getCt

public ComponentTypes getCt()

Gets the component type of the model object linked to this catalog.

Returns:

The component type.