Version: 1.3
LanguageEnglish
  • C#

SpeedTreeImporter

class in UnityEditor

/

Inherits from:AssetImporter

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

AssetImportor for importing SpeedTree model assets.

Static Properties

windQualityNamesGets an array of name strings for wind quality value.

Properties

alphaTestRefGets and sets a default alpha test reference values.
animateCrossFadingIndicates if the cross-fade LOD transition, applied to the last mesh LOD and the billboard, should be animated.
bestWindQualityReturns the best-possible wind quality on this asset (configured in SpeedTree modeler).
billboardTransitionCrossFadeWidthProportion of the last 3D mesh LOD region width which is used for cross-fading to billboard tree.
castShadowsGets and sets an array of booleans to enable shadow casting for each LOD.
castShadowsByDefaultGets and sets a boolean to toggle whether the imported SpeedTree casts shadows.
defaultBillboardShaderReturns the default SpeedTree billboard shader for the active render pipeline, or null if the asset is a SpeedTree v8 asset.
defaultShaderReturns the default SpeedTree shader for the active render pipeline (either v7 or v8 according to the asset version).
enableBumpGets and sets an array of booleans to enable normal mapping for each LOD.
enableBumpByDefaultGets and sets a boolean to enable normal mapping on the imported SpeedTree model.
enableHueGets and sets an array of booleans to enable hue variation effect for each LOD.
enableHueByDefaultGets and sets a boolean to enable hue variation effect on the imported SpeedTree model.
enableSettingOverrideGets and sets an array of booleans to customize importer settings for a specific LOD.
enableSmoothLODTransitionEnables smooth LOD transitions.
enableSubsurfaceGets and sets an array of booleans to enable the subsurface scattering effect for each LOD (affects only SpeedTree v8 assets).
enableSubsurfaceByDefaultGets and sets a boolean to enable the subsurface scattering effect for the SpeedTree asset (affects only SpeedTree v8 assets).
fadeOutWidthProportion of the billboard LOD region width which is used for fading out the billboard.
hasBillboardTells if there is a billboard LOD.
hasImportedTells if the SPM file has been previously imported.
hueVariationGets and sets a default hue variation color and amount (in alpha).
isIgnoreSimpleMeshVirtualGeometryAre some simple meshes ignored by Virtual Geometry.
isV8Returns true if the asset is a SpeedTree v8 asset.
LODHeightsGets and sets an array of floats of each LOD's screen height value.
mainColorGets and sets a default main color.
materialFolderPathReturns the folder path where generated materials will be placed in.
materialLocationMaterial import location options.
receiveShadowsGets and sets an array of booleans to enable shadow receiving for each LOD.
receiveShadowsByDefaultGets and sets a boolean to enable whether the SpeedTree asset receives shadows from other objects in your scene.
scaleFactorHow much to scale the tree model compared to what is in the imported SpeedTree model file.
selectedWindQualityGets and sets an integer corresponding to the SpeedTreeWind enum values. The value is clamped by SpeedTreeImporter.bestWindQuality internally.
useLightProbesGets and sets an array of booleans to enable Light Probe lighting for each LOD.
useLightProbesByDefaultGets and sets a boolean to enable light probe lighting for the imported SpeedTree model.
windQualitiesGets and sets an array of integers of the wind qualities on each LOD. Values will be clamped by SpeedTreeImporter.bestWindQuality internally.

Constructors

SpeedTreeImporterConstruct a new SpeedTreeImporter object.

Public Methods

GenerateMaterialsGenerates all necessary materials under materialFolderPath. If Version Control is enabled please first check out the folder.
SearchAndRemapMaterialsSearch the project for matching materials and use them instead of the internal materials.

Inherited Members

Properties

assetBundleNameGet or set the AssetBundle name.
assetBundleVariantGet or set the AssetBundle variant.
assetPathThe path name of the asset for this importer. (Read Only)
importSettingsMissingThe value is true when no meta file is provided with the imported asset.
userDataGet or set any user data.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

AddRemapMap a sub-asset from an imported asset (such as an FBX file) to an external Asset of the same type.
GetExternalObjectMapGets a copy of the external object map used by the AssetImporter.
RemoveRemapRemoves an item from the map of external objects.
SaveAndReimportSave asset importer settings if asset importer is dirty.
SetAssetBundleNameAndVariantSet the AssetBundle name and variant.
SupportsRemappedAssetTypeChecks if the AssetImporter supports remapping the given asset type.
GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

GetAtPathRetrieves the asset importer for the asset at path.
GetImportLogRetrieves logs generated during the import of the asset at path.
DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2024 Unity Technologies. Publication Date: 2024-11-15.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use