docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Retopologize

    Retopologize the input into a new mesh

    Inheritance
    object
    ActionBase
    ActionInOut<IList<GameObject>, IList<GameObject>>
    PixyzAction
    Retopologize
    Inherited Members
    PixyzAction.IsAsync
    PixyzAction.API
    PixyzAction.Algo
    PixyzAction.Core
    PixyzAction.CAD
    PixyzAction.Geom
    PixyzAction.Material
    PixyzAction.Scene
    PixyzAction.Polygonal
    PixyzAction.View
    PixyzAction.Converter
    PixyzAction.MeshSyncType
    PixyzAction.m_GameObjectToOccurrences
    PixyzAction.m_EntityToObject
    PixyzAction.m_LocalRoots
    PixyzAction.m_OutputOccurrences
    PixyzAction.kStartProgress
    PixyzAction.Run(IList<GameObject>)
    PixyzAction.PostProcess(ref IList<GameObject>)
    PixyzAction.Dispose()
    PixyzAction.CleanList(ref IList<GameObject>)
    ActionInOut<IList<GameObject>, IList<GameObject>>.InputType
    ActionInOut<IList<GameObject>, IList<GameObject>>.OutputType
    ActionInOut<IList<GameObject>, IList<GameObject>>.PreProcess(ref IList<GameObject>)
    ActionInOut<IList<GameObject>, IList<GameObject>>.Run(IList<GameObject>)
    ActionInOut<IList<GameObject>, IList<GameObject>>.PostProcess(ref IList<GameObject>)
    ActionBase.CreateInstance(Type)
    ActionBase.CreateInstance<T>()
    ActionBase.OnActionExecuted
    ActionBase.IsInRuleEngine
    ActionBase.IsInToolbox
    ActionBase.Color
    ActionBase.InputType
    ActionBase.OutputType
    ActionBase.Output
    ActionBase.HelpersMethods
    ActionBase.IsRunning
    ActionBase.GetInfo()
    ActionBase.Initialize()
    ActionBase.DisplayNameRuleEngine
    ActionBase.DisplayNameToolbox
    ActionBase.ActionNameToolbox
    ActionBase.ActionNameRuleEngine
    ActionBase.GroupNameToolbox
    ActionBase.GroupNameRuleEngine
    ActionBase.Invoke(object)
    ActionBase.ReportProgress(float, string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.PixyzPlugin4Unity.Actions
    Assembly: Unity.Pixyz.Plugin4Unity.Editor.dll
    Syntax
    public class Retopologize : PixyzAction

    Fields

    Name Description
    bakeMaps

    Transfer original mesh information into texture maps (Albedo, Normal, Opacity, Roughness, Specular, Metallic, Ambient Occlusion, Emissive).

    criterion

    Triangle count: driven by a specific targeted number of triangles.

    Triangle count: driven by percentage of mesh total number of triangles.

    featureSize

    Minimum feature size to preserve.

    gridResolution

    Specify the voxel grid resolution. A setting of 'x' divides the model into roughly x³ voxels. Increasing this value may result in longer processing times and more triangles in the output mesh.

    gridResolutionPreset

    Voxelization quality presets.

    mapsResolution

    Generated textures size.

    offset

    Offset used to generate the baking cage. Increase to lower baking artifacts in case of a large geometric error between source and retopologized mesh.

    resolution

    Generated textures size.

    targetRatio

    Approximate output ratio triangle count. Choose 0% to 100%.

    targetTriangleCount

    Approximate output triangle count.

    type

    Standard: create a rough mesh approximation driven by quality target.

    Field-Aligned (Preview): create a field-aligned quad-dominant mesh with control on triangle count.

    upSampling

    Baking up-sampling coefficient: bake at a higher resolution than desired output textures resolution, then resize.

    useFeatureSize

    If activated, Asset Transformer will try to preserve mesh details larger than chosen feature size.

    Properties

    Name Description
    HierarchyMode

    Returns how the hierarchy is synced with pixyz

    Icon

    Icon to be displayed in Toolbox and Rule Engine. If null, no icon will be displayed. To support light and dark themes: specify light theme path. Dark theme file name should be the same with a "d_" prefix. To support selected and unselected states: selected files names should be the same as main files but with a "s_" prefix.

    Id

    The id of the Acton implementation. This id should be unique and is readonly. The id is the actual reference if the Action is serialized (in a set of RuleEngine Rules for example).

    MenuPathRuleEngine

    The menu path for the RuleEngine.

    MenuPathToolbox

    The menu path for the Toolbox.

    Priority

    The order to use when placing this Action in a list. If the value is -1, the display name will be used instead;

    SyncMaterials

    Returns how material are synced with pixyz

    Tooltip

    Returns the tooltip.

    Methods

    Name Description
    GetErrors()

    Virtual method for Error checks before execution.

    GetWarnings()

    Virtual method for Warning checks before execution.

    OnValueChanged()

    Virtual method for implementing operations when a value changed.

    PreProcess(ref IList<GameObject>)

    Use to validate/modify the input before the 'Run' method is executed. Always executed on the main thread.

    Run(OccurrenceList)

    Runs in Pixyz context. To be overriden in the derived class.

    Validate(object)

    Called to validated/check the new input (new selection in the editor with toolbox action, or before running action in ruleset)

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)