Rename VariantMap and VariantResource classes#182
Merged
Conversation
Xrayez
added
enhancement
This class was first renamed from `Grid2D` in #67 to avoid confusion with `GridRect`. After using the class more, it becomes apparent that `Map2D` better reflects the functionality here, because it allows to map 2D Cartesian coordinates to values. This also avoids using `Variant` in a class name, which is frankly redundant.
1. The `Resource` is described as a class intended to be used as a data container. Because `DataContainer` is a `Resource` that handles any `Variant` data, it makes sense to name it that way. 2. Godot has a similar `PackedDataContainer`, which packs `Variant` as `PoolByteArray`. 3. Avoids using `Variant` in a class name, which is redundant (same as in `VariantMap` renamed to `Map2D` now).
Xrayez
force-pushed
the
prune-variant-from-class-names
branch
from
0a31c7d to
e761daa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #176.
VariantMap→Map2DThis class was first renamed from
Grid2Din #67 to avoid confusion withGridRect. After using the class more, it becomes apparent thatMap2Dbetter reflects the functionality here, because it allows to map 2D Cartesian coordinates to values.Map3Dcould also be implemented.This should also signify that the API may be similar to
TileMap,BitMap,Image(technically aPixMap, you may see this name in some image processing libraries).This also avoids using
Variantin a class name, which is frankly redundant.VariantResource→DataContainerResourceis described as a class intended to be used as a data container. BecauseDataContaineris aResourcethat handles anyVariantdata, it makes sense to name it that way.PackedDataContainer, which packsVariantasPoolByteArray.Variantin a class name, which is redundant (same as inVariantMaprenamed toMap2D).